"Komentar cenderung menjadi usang."
Saya telah melihat ini terjadi cukup sering untuk mengetahui ini bisa menjadi masalah.
Masalahnya, saya pikir saya telah melihat mungkin dua atau tiga komentar usang sepanjang karir saya.
Saya percaya itu harus sangat mungkin untuk bekerja di lingkungan di mana semua orang cukup memperhatikan komentar dan mempertahankannya. Hanya sedikit usaha ekstra untuk melihat komentar di dekat kode yang sedang Anda edit dan memperbaruinya bila perlu. Jika komentarnya begitu jauh sehingga Anda tidak segera melihatnya, itu adalah komentar yang buruk, dan seharusnya tidak ditambahkan di tempat pertama (atau setidaknya tidak ada di sana).
Selain itu biasanya bersama dengan pernyataan bahwa komentar cenderung menjadi ketinggalan zaman, mengikuti pernyataan bahwa ini mengurangi keterbacaan dan membingungkan orang. Ini adalah sesuatu yang belum saya alami. Setiap kali saya menjumpai komentar yang kedaluwarsa, saya melihat dengan jelas apa yang berubah dan hanya memperbarui komentar yang sesuai untuk mewakili kode yang lebih baru, meskipun dengan upaya ekstra.
Sebuah studi terbaru oleh Roehm et al. 2012 mengamati hal-hal berikut:
21 peserta [dari 28] melaporkan bahwa mereka mendapatkan informasi utama dari kode sumber dan komentar inline sedangkan hanya empat yang menyatakan bahwa dokumentasi adalah sumber utama informasi mereka.
Ini sesuai dengan kecurigaan Anda bahwa komentar dalam kode itu sendiri umumnya masih dianggap sangat berguna. Ini menunjukkan bahwa garis yang jelas harus ditarik antara dokumentasi yang ketinggalan jaman dan komentar yang ketinggalan zaman .
Roehm, T., Tiarks, R., Koschke, R., & Maalej, W. (2012, Juni). Bagaimana pengembang profesional memahami perangkat lunak? Dalam Prosiding Konferensi Internasional 2012 tentang Rekayasa Perangkat Lunak (hlm. 255-265). IEEE Press.