Dokumentasikan Project dengan Doxygen – case: Open Mitra Desa

Gaya menulis kode program yang rapih dan mudah dibedah ulang  adalah yang berorientasi objek. Mulai dair C++, PHP, Java, Python, Ruby dan masih banyak bahasa pemrograman berorientasi objek.

Ketika kita koding, seharusnya kita mendokumentasikan hasil cerita novel dalam kode (kodingan) dalam suatu dokumentasi. Dokumentasi itu bisa berupa rancangan alur sistem, UML,  design database,  purwarupa, class reference, etc…

Kali ini saya ingin berbagi kiat membuat dokumentasi project yang berisi class reference, data stucture, dan class diagram. Studi kasusnya, saya sedang membuat aplikasi administrasi pemerintahan desa yang dinamai Open Mitra Desa. Saya mencoba membuat dokumentasi dari berkas project tersebut. Kebetulan saya memakai lingkungan pemrograman PHP dan Yii Framework.

Kebutuhan (bisa dikatakan yang saya gunakan):

Perangkat keras

  • Komputer (*required)
  • Jari jemari (optional)
  • Kopi hitam (optional)

Perangkat lunak

  • Sistem Operasi Linux (saya memakai BlankOn; karena produk dalam negeri)
  • Doxygen (compiler dokumentasi)
  • Doxygen GUI (yang versi grafis)
  • Graphviz (untuk membangkitkan graph – class diagram)
  • …. pikiran dan mood yang jernih

Langkah-langkah

1. Menuju terminal gelap untuk memasang perabotan

sudo apt-get install doxygen doxywizard graphviz

2. Jalankan aplikasi doxigen versi GUI (pake terminal aja; kebiasaan)

doxywizard

3. Pengaturan (ikuti seperti gambar berikut)

Doxygen Configuration

Pengaturan: Tab Wizard > Project

Doxygen Configuration

Pengaturan Doxygen: Tab Wizard > Diagrams

Doxygen Configurations : Dot/Graphviz

Pengaturan Doxygen: Tab Expert > Dot (supaya dibangkitkan gambar class diagram dengan graphviz)

Doxygen Run

Jalankan aksi doxygen dari beberapa pengaturan tadi di atas : Run

Hasil

Hasilnya maka kita akan memiliki satu direktory web (html compiled) yang berisi dokumentasi project kita. Eng ing eng….

Hasil: Open Mitra Desa Class Diagram

Hasil: Open Mitra Desa Class Diagram

Result : Hasil Dokumentasi Project

Hasil Dokumentasi Project, lengkap dengan class reference, help, dan diagram class nya

Demikian pengetahuan yang bisa saya bagi untuk dokumentasikan tulisan novel kode kita supaya reusable, redevelopable. Selamat mencoba, semoga bermanfaat

One thought on “Dokumentasikan Project dengan Doxygen – case: Open Mitra Desa

Leave a Reply

Your email address will not be published. Required fields are marked *