Apakah ada panduan yang pasti untuk menulis komentar kode, yang ditujukan untuk pengembang pemula?
Idealnya, itu akan mencakup kapan komentar harus (dan tidak boleh) digunakan, dan komentar apa yang harus berisi.
Jangan berkomentar APA yang Anda lakukan, tetapi MENGAPA Anda melakukannya.
WHAT dirawat dengan kode yang bersih, mudah dibaca, dan sederhana dengan pilihan nama variabel yang tepat untuk mendukungnya. Komentar menunjukkan struktur level yang lebih tinggi ke kode yang tidak dapat (atau sulit untuk) ditunjukkan oleh kode itu sendiri.
datang dekat, tapi itu sedikit ringkas untuk programmer yang tidak berpengalaman (perluasan pada itu dengan beberapa contoh dan kasus sudut akan sangat baik, saya pikir).
Pembaruan : Selain jawaban di sini, saya pikir jawaban untuk pertanyaan lain ini sangat relevan.