Quantcast
Channel: Etersoul Journey » kode
Viewing all articles
Browse latest Browse all 3

Pentingnya dokumentasi program

$
0
0

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 //

Pada kenyataannya dokumentasi memang merupakan hal penting yang sering terlupakan atau bahkan sengaja dilupakan oleh programmer. Kebanyakan programmer tidak menyukai dokumentasi karena mengaggap dokumentasi akan membuang-buang waktu pada saat melakukan coding dalam source codenya. Memang benar bahwa menulis dokumentasi, khususnya dokumentasi yang baik memerlukan waktu. Bayangkan saja sebuah baris dokumentasi yang diselipkan dalam kode program memerlukan waktu 10 detik untuk menulis kata-katanya, padahal tanpa menulis dokumentasi, biasanya programmer sudah dapat menulis 2 baris kode lainnya. Akan tetapi ketika nanti programmer tersebut harus kembali membaca baris itu, maka 2 baris kode itu mungkin saja akan memakan waktu lama untuk dimengerti logikanya bila tidak terdapat satu pun clue untuk membantu programmer itu untuk mengintepretasikan 2 baris kode itu.

Comment-comment ini umumnya cukup ditulis pada baris-baris logika yang memerlukan bantuan agar dapat lebih mudah dimengerti, akan tetapi beberapa programmer juga menulis comment pada baris-baris yang logikanya mungkin tidak terlalu sulit tetapi bisa membantu mempercepat proses membaca lagi kode itu. Bayangkan bila sebuah source code aplikasi yang sudah ditinggal selama berbulan-bulan, tentu saja bukan tidak mungkin logika yang dipakai dalam suatu bagian sampai terlupakan sama sekali.

Selain sebagai fungsi keterbacaan, terkadang dokumentasi dalam bentuk comment juga bisa membantu dalam mencari suatu baris kode di antara ribuan baris kode yang ada. Blok dokumentasi di awal file, di sekitar function atau di sekitar class atau semacamnya akan membantu dalam mengatahui batas antara satu file, function atau class dengan yang lainnya. Contoh menulis sebuah dokumentasi dalam bentuk DocBlock pada function adalah sebagai berikut:

/**
 * Function yang digunakan untuk blablabla
 *
 * @access public
 * @param string Penjelasan parameter pertama
 * @return int Penjelasan hasil return
 **/
function blablabla()

Dokumentasi juga akan sangat membantu bila suatu kali sebuah source code harus dibaca oleh programmer yang baru menangani source code tersebut.

Intinya dokumentasi menjadi penting pada masa setelah penulisan source code tersebut sehingga seharusnya tidak dilupakan oleh seorang programmer. Setidak-sukanya seorang programmer dalam menulis dokumentasi, paling tidak dokumentasi dalam bentuk comment sederhana sudah dapat membantu dalam readability suatu source code. Jadi, jangan malas menulis dokumentasi. ;)


Viewing all articles
Browse latest Browse all 3

Latest Images

Trending Articles





Latest Images