Pertanyaan tentang menulis komentar dalam kode.
Banyak orang mengklaim bahwa "komentar harus menjelaskan 'mengapa', tetapi tidak 'bagaimana'". Yang lain mengatakan bahwa "kode harus mendokumentasikan diri sendiri" dan komentar harus langka. Robert C. Martin mengklaim bahwa (diucapkan dengan kata-kata saya sendiri) sering "komentar adalah...
Salah satu anggota tim saya secara konsisten menghindari membuat komentar dalam kodenya. Kode-nya tidak mendokumentasikan diri sendiri, dan programmer lain kesulitan memahami kode-nya. Saya telah memintanya beberapa kali untuk mengomentari kodenya, namun dia hanya memberikan alasan atau klaim...
Saya telah bekerja di toko-toko yang menghasilkan perangkat lunak yang sangat penting dan saya telah berurusan dengan aturan komentar yang dimaksudkan agar kode tersebut dapat dibaca dan berpotensi menyelamatkan nyawa. Dalam pengalaman saya meskipun persyaratan menjadi tugas yang mematikan otak...
Seorang rekan kerja saya percaya bahwa setiap penggunaan komentar dalam kode (yaitu, bukan metode gaya javadoc atau komentar kelas) adalah bau kode . Bagaimana menurut
pengembang junior di sini. Saat ini saya bekerja sendiri di aplikasi web untuk klien besar perusahaan saya. Saya mulai bulan lalu. Klien menginginkan setidaknya 25% komentar di setiap proyek perangkat lunaknya. Saya memeriksa kode aplikasi sebelumnya dan berikut adalah pengamatan saya: setiap...
Saya mengerjakan proyek yang cukup besar dan mendapat tugas untuk melakukan beberapa terjemahan untuknya. Ada banyak label yang belum diterjemahkan dan ketika saya sedang menggali kode, saya menemukan sepotong kode ini //TODO translations Ini membuat saya berpikir tentang arti dari...
Saya menulis kode berikut: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl());
Saya sedang berdiskusi dengan kolega baru saya mengenai komentar. Kami berdua menyukai Kode Bersih , dan saya baik-baik saja dengan fakta bahwa komentar kode sebaris harus dihindari dan bahwa nama kelas dan metode harus digunakan untuk mengekspresikan apa yang mereka lakukan. Namun, saya penggemar...
Saya tahu bahwa Subversion (apa yang kami gunakan di tempat kerja) dapat dikonfigurasikan untuk memerlukan komentar saat melakukan, namun saya tidak dalam posisi yang kuat untuk mengaktifkannya. Saya tahu bahwa alasan saya berkomentar tentang komitmen saya adalah karena berguna, jika hanya sebagai...
Pertama-tama, dalam pertanyaan ini saya ingin menjauh dari polemik apakah komentar kode sumber itu baik atau buruk. Saya hanya mencoba memahami dengan lebih jelas apa yang dimaksud orang ketika mereka berbicara tentang komentar yang memberi tahu Anda MENGAPA, APA atau BAGAIMANA. Kita sering...
Saya diajari oleh bos saya (saya baru saja selesai sekolah dan dia menginginkan seseorang dengan sedikit pengalaman pemrograman, jadi dia memilih saya untuk melatih saya tentang apa yang menjadi spesialisasi perusahaan itu) dan mulai bekerja dengan aplikasi ASP.NET MVC , beberapa HTML dan CSS ....
Apa yang orang umumnya maksud setiap kali Anda melihat XXXdi komentar. Terkadang, saya akan melihat komentar seperti ini: # XXX - This widget really should frobulate the whatsit Tentu saja, saya dapat mengatakan apa arti komentar tersebut, tetapi apa arti XXX secara umum? Apakah itu mengatakan...
Saya baru saja menemukan diri saya menulis komentar berikut dalam beberapa kode (kuno Visual Basic 6.0) yang saya tulis: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Saya tidak yakin mengapa saya secara tidak sadar menggunakan "kami" dalam...
Latar Belakang Saya bekerja di tim yang ingin menerapkan penerapan zero-downtime. Kami berencana menggunakan strategi penyebaran biru / hijau untuk mencapai ini. Salah satu hal yang saya sadari dalam melakukan penelitian adalah betapa rumitnya membuat perubahan database. Operasi sederhana seperti...
Seseorang pernah berkata kita harus mengawali semua metode kita dengan /// <summary>blok komentar (C #) tetapi tidak menjelaskan mengapa. Saya mulai menggunakannya dan menemukan mereka sedikit mengganggu saya, jadi berhenti menggunakannya kecuali untuk perpustakaan dan metode statis. Mereka...
Kami telah diminta untuk menambahkan komentar dengan tag awal, tag akhir, deskripsi, solusi dll untuk setiap perubahan yang kami lakukan pada kode sebagai bagian dari perbaikan bug / penerapan CR. Kekhawatiran saya adalah, apakah ini memberikan nilai tambah? Karena itu, kami memiliki semua detail...
Apakah ini praktik yang baik untuk memasukkan nomor bug dalam file itu sendiri di dalam komentar header? Komentar akan terlihat seperti ini: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error...
Saya terus-menerus melihat orang-orang membuat klaim bahwa "komentar cenderung menjadi ketinggalan zaman." Masalahnya, saya pikir saya telah melihat mungkin dua atau tiga komentar usang sepanjang karir saya. Informasi yang sudah ketinggalan zaman dalam dokumen terpisah terjadi setiap saat, tetapi...
Sepanjang program, Anda akan berakhir dengan beberapa komentar yang menjelaskan kode dan beberapa komentar yang menghapus kode: // A concise description const a = Boolean(obj); //b = false; Apakah ada metode yang baik untuk mem-parsing yang mana? Saya telah bermain-main dengan menggunakan 3...
Dengan asumsi komentar tidak sesuai (atau tidak bisa) pada baris yang berlaku, haruskah seseorang menulis komentar sebelum kode atau setelahnya? Nah, di mana pun pembaca di masa depan akan lebih memahami ruang lingkup komentar. Dengan kata lain, di mana pun kebanyakan programmer / penulis naskah...