Hal yang kelihatannya sepele, meskipun kamu punya projek solo, maksudnya cuma kamu sendiri maintainernya.

Ngasih komen sesederahana ini sangat bermanfaat untuk dirimu sendiri di masa depan yang mungkin udah lupa dengan alur berpikir saat penulisan kode pertama kali.

Sehingga jadi lebih yakin saat akan menambah / memodifikasi kode karena ada pesan dari dirimu di masa lalu.

Ternyata pesan komentar pada kode itu bisa menembus waktu ya. Hmm menarik. Tapi ingat, ngasih komennya yang berfaedah ya, jangan hal-hal yang udah terlalu jelas malah dikasih komen, malah gak enak dilihat.

Saya yakin sebagian besar dari kalian belum pernah mendengar tentang Literate programming.

Ini merupakan dunia lain dalam paradigma pemrograman.

Jika umumnya sebuah kalimat penjelasan diletakkan di dekat kode tertentu untuk memberikan kejelasan sebagai sebuah “komentar”

Pada Literate programming, justru bagian utamanya adalah bagian kalimat penjelasannya yang ditulis dengan bahasa alami yang mudah di mengerti.

Sehingga akan jelas alasan pemilihan metode yang digunakan dalam kode, logikanya dan penjelasan lain yang lebih detail.

Tentu ini memerlukan effort yang sangat ekstra, karena programmer selain menulis kode harus menjabarkan secara detail latar belakang kode tersebut ditulis, secara detail loh ya, bisa ber paragraf-paragraf untuk kode yang sebenarnya singkat.

Hal ini memang kurang praktikal bagi mayoritas pemrogram, Oleh karenanya sebetulnya gak perlu Literate programming kita tetap bisa mendapatkan manfaatnya yakni dengan komentar pada kode yang menjelaskan alasan dan pertimbangan kenapa menggunakan kode itu.

Singkat saja, asal menjelaskan. Dan jangan mengomentari yang sudah jelas.

Saya malah agak aneh, ketika ada yang anti terhadap komentar di kode. Coba kalian lihat source projek-projek open source yang tenar, gak mungkin lepas dari komentar yang panjang-panjang.

Karena komentar itu juga berfungsi sebagai dokumentasi built-in yang bisa dibaca oleh kontributor lainnya. Dan sebagai alat komunikasi yang natural bagi sesama programmer.