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 melihat pedoman seperti "Komentar harus memberi tahu MENGAPA; kode itu sendiri harus memberi tahu Anda BAGAIMANA". Sangat mudah untuk menyetujui pernyataan pada tingkat abstrak. Namun, orang biasanya menjatuhkan ini seperti dogma, dan meninggalkan ruangan tanpa penjelasan lebih lanjut. Saya telah melihat ini digunakan di banyak tempat dan konteks yang berbeda, sehingga sepertinya orang-orang dapat menyetujui slogannya, tetapi mereka tampaknya berbicara tentang hal-hal yang berbeda sama sekali.
Jadi, kembali ke pertanyaan: jika komentar harus memberi tahu MENGAPA, mengapa ini MENGAPA kita bicarakan? Apakah ini alasan mengapa potongan kode itu ada di tempat pertama? Apakah ini yang harus dilakukan oleh kode bagian itu? Saya akan sangat menghargai jika seseorang dapat memberikan penjelasan yang jelas, dan kemudian menambahkan beberapa contoh yang baik (contoh buruk tidak benar-benar diperlukan, tetapi jatuh bebas untuk menambahkannya sebagai kontras).
Ada banyak pertanyaan tentang apakah komentar itu baik atau buruk, tetapi tidak ada yang menjawab pertanyaan spesifik tentang apa contoh komentar yang baik yang memberi tahu Anda MENGAPA.
There are many questions on whether comments are good or bad, but no one that addresses the specific question of what are good examples of comments that tell you WHY.
Jika semua orang memberikan contoh yang valid, maka mereka semua adalah jawaban yang benar. Format situs web ini adalah untuk memfasilitasi proses tanya jawab di mana tidak semua jawaban dibuat sama.