Langsung ke konten utama

Tool Dokumentasi Pengembangan Software

oleh : Candra Adi Putra [aptx49@akakom.org]

1 Pendahuluan

Apakah anda seorang programmer?Jika jawaban anda
ya,maka anda akan tertarik dengan tulisan ini.Bahasa
apa yang anda pakai?C,C++,Java ,php atau C#? atau
jangan-jangan bahasa anda tidak ada dalam list ?Sungguh
menyedihkan jika anda masih memakai pascal atau basic
untuk pengembangan software saat ini :-(.

2 Metodologi Pengembangan

Dalam metodologi pengembangan software,kita masih ingat
dengan bagan pengembangan dengan proses atau langkah
langkah seperti :perancangan,design,coding,testing
,dokumentasi dan perawatan.Umumnya langkah-langkah di
atas menggunakan tool bantu dalam pengerjaannya ,sebut
saja proses design,kita bisa memakai UML
UML:unified? Modeling Language,merupakan notasi standar
dalam menggambarkan design Program untuk pengembangan
berorientesi objek,namun anehnya masih ada orang yang
mendesign atau menerangkan OOP dengan flowcart,hal yang
paling konyol yang yang pernah saya temui :-|.
jika anda menggunakan pendekatan OOP
Object oriented programming alias pemrograman
beroreintasi object.
dan OOAD:Object Oreinted Analisis design,namun
jika anda memakai pendekatan lain
mungkin tool yang anda pakai akan berbeda (jika anda
masih memakai flowchart dan pemrograman prosedural
untuk membuat software maka anda termasuk tipe orang
yang static atau mungkin anda mengira jika sekarang
masih era 80-an :D) .Umumnya waktu terlama dan hal yang
paling membosankan adalah proses pembuatan
dokumentasi.Kita tahu kalau umumnya programmer bukan
orang yang suka mendongeng dan menulis cerita yang
tidak logis :-D.Untuk itulah sekarang ini muncul tool
tool yang secara otomatis melakukan dokumentasi untuk
anda.Tool seperti ini biasanya disebut dokument generator.

3 Dokumentation Generator

Dokument generator adalah tool yang digunakan untuk
memparsing dan menghasilkan output dari
komentar-komentar source code program.Konsep kerjanya
berlawanan dengan compiler dimana compiler membuang
atau memekai prinsip "emang gue pikirin" jika menemui
baris komentar ,maka document generator ini justru
mengacuhkan code program dan menekankan pada
dokumentasi code program.Setahu saya, konsep ini awal
mulanya dimotori oleh java dengan javadoc nya. Pada
akhirnya banyak diikuti oleh bahasa pemrograman
lain.Berikut ini adalah tool-tool yang cukup terkenal
dalam pendokumentasian code program.Jika bahasa
kesayangan anda tidak ada atau tidak tertera dalam tool
tool ini mungkin saatnya bagi anda membuat tool
dokumentasi anda sendiri .Siapa tahu tool anda bisa
sepopuler javadoc ataupu n doxygen.

3.1 Javadoc

Javadoc adalah tool dokumentasi yang terdapat di JDK.
Output dari javadoc umunya berupa html .Aturan javadoc
sendiri cukup sederhana dimana javadoc hanya akan
membuatkan dokumentasi untuk komentar gaya java dengan
format sbb:

/**

*Ini adalah gaya komentar java yang nantinya

* diproses oleh javadoc.

*/

3.2 Doxygen

Doxygen adalah tool pendokumentasian multi bahasa
pemrograman.Sampai saat ini doxygen mampu membuat
dokumentasi dari komentar bahasa c++,java,PHP,c# dan
beberapa bahasa lain dengan output html.jJka anda
menginginkan format lain anda mungkina akan tertarik
dengan robodoc dimana tool ini mampu menghasilkan
dokumentasi dalam format text,html,ps,pdf ataupun latex.

3.3 PHPdoc

dari namanya saya kira ada sudah tahu.Tool ini adalah
tool untuk mendokumentasikan code php.Perl dan juga
pyton juga sepertinya punya tool dokumentasi sendiri.
perldoc untuk perl dan pydoc untuk python.

3.4 C#

Masih banyak tool tool sejenis yang lain,namun tool
yang bikin saya geleng-geleng kepala adalah tool nya C#
dimana komentar program akan dijadikan format XML
,terus terang selangkah lebih maju dari javadoc.

syntax komentar dari C# yang akan diproses menggunakan
gaya komentar seperti ini

/// ini dokumentasi C# yang nantinya

///digenerate oleh tool pendokumentasi dari

///.NET SDK

4 Penutup

Dari urain diatas bisa kita simpulkan,dengan tool tool
ini maka pengembangan suatu software bisa menjadi lebih
cepat karena dokumentasi bisa dilakukan bersamaan
dengan coding.Walaupun tentunya tool-tool ini terbatas
pada dokumentasi teknis.Namun jika kita bisa
membiasakan pendokumentasian seperti ini maka program
kita akan mudah dibaca baik oleh kita,rekan satu
tim,ataupun oleh orang lain.

Komentar

Postingan populer dari blog ini

Cara membuat distro Linux

Sudah setahun Distro Linux Etix di release. Ada beberapa komentar dan email yang masuk ke inbox penulis tentang cara pembuatan dan gambaran pembuatan linux from Stratc h. Akhirnya setelah sekian lama, dokumentasi teknis resmi saya publikasikan dengan lisensi   free for non komersial use , bisa saja di kemudian hari lisensi saya ubah jika memang ada pertimbangan lain. Jika dokumentasi ini membingungkan atau kurang lengkap, anda bisa membaca  referensi lain diinternet yang umumnya tersedia secara gratis atau silahkan menanyakan langsung ke pada saya. Dokumentasi ini sendiri sebenarnya adalah naskah tugas akhir saya ketika kuliah di STMIK AKAKOM dimana saya mengambil thema Linux dengan judul " Pengembangan distribusi Linux ETIX untuk Lingkungan belajar Java" untuk menyelesaikan kuliah dan mendapat gelar S1. Diharapkan dengan didistribusikannya dokumentasi pembuatan ini bisa menambah wawasan baru tentang cara pembuatan distro Linux dan tool-tool yang dipakai. Kritik, saran, ...

cara mempopulerkan blog

Berikut ini adalah cara yang bisa kita pake agar blog kita bisa makin populer atau pake bahasa mudahnya makin banyak orang yang mengunjungi blog kita. 1.kamu harus punya blog dulu,ini harus kamu bisa buat di wordpress,blogger atau di Friendster sekalian digabungin ama profil kamu. 2.pastikan di setting blog kamu di setting " Allow blog listing" atau kata lain yang intinya search engine dibolehkan untuk menambahkan kedalam list mereka.jika bingung biarkan secara default. 3.Isinya menarik,spesifik dan unik,kalo bisa blog kamu berisi artikel tentang satu bahasan aja,misal masalah IT,movie,buku,software,agama atau apa saja.dan yang lebih penting lagi orang lain bisa mengambil manfaat dari blog kamu,jangan jadikan blog cuma sekedar mencurahkan isi hati kamu,walaupun ga ada salahnya memang. 4.secara manual kamu bisa menambahkan blog kamu kedalam search engine,biasanyadi search engine besar seperti google ada link untuk " submit your site ". 5.sering ...

Troubleshooting HD Audio di windows XP sp3

Jika anda saat ini masih menggunakan Windows XP Sp3 dan chipset Audio di Motherboard anda menggunakan Realtek HD audio, kemunginkan sound anda tidak akan terdeteksi walaupun Driver yang sudah anda install sudah cocok, baik anda install dari driver bawaan Motherboard ataupun langsung unduh di Situs resminya. Mengapa demikian? ternyata ini kesalahan dari Windows XP SP3 itu sendiri dimana sp3 "lupa" untuk menyertakan Deteksi chipset audio jenis ini. Jika anda mengalami hal yang sama, ada cara sederhana untuk menyelesaikannya hanya dengan mengikuti langkah berikut. 1. Install driver audio anda seperti biasa, lalu restart komputer anda. Jika anda menggunkan Notebook Axio, anda bisa mendownload drivernya di  website Axioo .  2. Download patch untuk SP3 anda di link berikut  http://www.4shared.com/account/file/DqGsp67D/winxpSp3_UA_HD_Audio.html . 3. Setelah download selesai, Ekstrak file tersebut.  4. Buka Device Manager, dan anda akan melihat tanda ser...