Dokumentasi pemrograman adalah sebuah cara yang dilakukan
oleh pemrogram dalam mengumpulkan serta mendefinisikan berbagai hal yang ia
kerjakan dalam suatu project. Para pemrogram mempunyai cara masing - masing
dalam menyusun dokumentasinya. Tidak ada aturan baku dalam hal ini, namun
menurut saya seorang pemrogram haruslah memilki kepekaan diri untuk membuat
dokumentasi disetiap project yang ia kerjakan. Hal ini berguna baik untuk
dirinya maupun pemrogram lain dalam memelihara system atau aplikasi yang ia
buat. Ditulisan ini saya akan berbagi beberapa cara mendokumentasikan project
yang biasa saya lakukan. Cekidot..
- Dokumentasi Komentar
Cara pertama yang biasa saya lakukan
adalah membuat dokumentasi berupa komentar – komentar yang saya sematkan
didalam blok kode pemrograman yang saya buat. Cara ini cukup sederhana, hanya
perlu memberikan komentar pada setiap function, logic atau rules yang saya
buat. Komentar itu berisikan tujuan dan penggunaan blok kode pemrograman yang
saya buat. Berikut contoh dokumentasi komentar yang saya buat dalam bahasa
pemrograman Php :
//
FUNGSI TAMBAH START
function tambah
($a, $b){
$hasil = $a + $b;
return $hasil;
}
//
FUNGSI TAMBAH END
- Dokumentasi Kertas
Yang dimaksud dengan dokumentasi
kertas adalah saya membuat definisi dan tujuan dari setiap blok kode yang saya
buat didalam lembar kerja seperti MS. Word, pdf dan lain – lain. Caranya cukup
sederhana dan mirip seperti dokumentasi komentar namun mungkin lebih detail,
contoh :
- Fungsi Tambah
/*Fungsi ini dibuat untuk menghitung setiap
variable yang didapat oleh parameter $a dan $b. Fungsi ini terdapat didalam
controller Hitung.*/
// FUNGSI
TAMBAH START
function tambah
($a, $b){
$hasil = $a + $b;
return $hasil;
}
//
FUNGSI TAMBAH END
Itu
tadi dua jenis dokumentasi yang biasa saya buat dalam mengerjakan project,
untuk dokumentasi komentar itu sih wajib menurut saya, sedangkan dokumentasi
kertas biasanya itu saya buat untuk kebutuhan project yang memerlukan
penyerahan dokumentasi pada client. Tidak lengkap kalau kita tidak membahas
kelebihan dari dokumentasi tersebut, berikut kelebihan jika kita membuat
dokumentasi pemrograman :
- Memudahkan setiap pemrogram dalam membaca alur system atau
aplikasi yang dibuat baik pembuat aslinya maupun pemrogram lain.
- Mempercepat proses pemeliharaan system atau aplikasi
- Dapat meringkas kode dikemudian hari karena memiliki
scriptingnya (khusus dokumentasi kertas).
Oke,
itu tadi sedikit penjelasan mengenai dokumentasi pemrograman, jenis dan
kelebihan yang biasa saya buat sebagai pemrogram.
Mudah
– mudahan bermanfaat, senang bisa berbagi.
Wassalam…