Dokumentasi Kode Program

Dokumentasi Kode Program

Dokumentasi Kode Program

Dokumentasi Kode Program

Dokumentasi kode program, merupakan dokumentasi yang harus ada dalam program, untuk memberikan penjelasan kepada setiap baris atau pun blok perintah dalam program.

Dokumentasi program diperlukan bagi programmer itu sendiri, untuk dapat menelusuri logika program. Karena biasanya, pemrogram akan lupa akan alur programnya sendiri. Apalagi jika sudah lama sudah ditinggalkan, karena mengerjakan pekerjaan lain. Pada saat harus memperbaiki atau menyempurnakan, programmer sering harus mempelajari terlebih dahulu alur programnya sendiri, baru kemudian baru bisa melakukan modifikasi sesuai dengan yang diinginkan.

Dari sisi lain, dokumentasi juga diperlukan untuk memudahkan untuk memvalidasi apakah program yang telah dikembangkan, sudah sesuai dengan yang dispesifikasikan atau belum. Proses validasi ini akan dilakukan oleh tim penguji (validator).

Dokumentasi kode program merupakan pelengkap dokumentasi spesifikasi, karena menjelaskan bagaimana dari spesifikasi diterjemahkan ke dalam program.

Jika dokumentasi spesifikasi tidak ada maka dokumentasi kode program akan menjadi dokumentasi yang sangat berharga, karena bukan menjadi dokumen pelengkap tetapi menjadi dokumentasi utama.

Dokumentasi dalam kode program umumnya dilakukan dengan menuliskan baris-baris komentar dalam kode sumber programnya. Isi dari dokumentasi kode program, setidaknya terdiri atas:

  • langkah-langkah dalam program untuk menyelesaikan masalah
  • komentar dituliskan pada setiap awal modul atau fungsi,
  • jika mungkin komentar ditulis pada setiap blok program, jika tidak maka ditulis pada blok-blok yang penting saja. Lebih baik lagi jika setiap baris ada komentarnya.
  • Informasi tentang siapa yang membuat, kapan pertamakali dibuat, kapan terakhir diperbaiki, jika mungkin informasi perubahan dari waktu ke waktu

Cara menuliskan komentar harus mengikut kepada cara penulisan yang baku. Jika menggunakan bahasa pemrograman Java, maka dapat menggunakan format yang telah ditetapkan oleh javadoc.

Baca Juga :