Pentingnya dokumentasi program
Ada sebuah paragraf yang dibuat oleh para programmer yang sekaligus penulis dokumentasi atas sebuah framework open source bernama CodeIgniter seperti di bawah ini.
Programmers love to code and hate to write documentation. We’re no different, of course, but since documentation is as important as the code itself, we are committed to doing it. Our source code is extremely clean and well commented as well.
Bila diterjemahkan ke Bahasa Indonesia, ungkapan itu kurang lebih berarti seperti di bawah ini:
Programmer suka menulis kode dan benci menulis dokumentasi. Kami juga tidak berbeda tentunya, tetapi karena dokumentasi sama pentingnya dengan kode itu sendiri, kami berkomitmen untuk melakukan itu (menulis dokumentasi). Source code kami sangat bersih dan terdokumentasi juga.
Dokumentasi di sini tidak hanya bererti menuliskan dokumentasi penggunaannya, melainkan dokumentasi atas kode yang dibuat programmer. Umumnya dokumentasi menggunakan comment block atau comment line untuk memisahkan dari kode utama. Sebagai contoh, comment block pada bahasa pemrograman C++ dan beberapa bahasa pemrograman lain adalah /* dan */, sedangkan comment line adalah //




