Dokumentasi Source Code Menggunakan Tools Doxygen

Senin, Desember 15, 2008 | , | Comments

Bagi anda, seorang programmer, yang menginginkan dokumentasi kode program yang anda buat, Doxygen merupakan salah satu tools yang dapat anda gunakan untuk menghasilkan dokumentasi secara otomatis. Doxygen dapat membuatkan dokumentasi kode program bahasa C++, C, Java, Objective-C, Python, IDL (Corba dan Microsoft flavors), Fortran, VHDL, PHP, C#, dan lainnya. Hasil dokumentasi yang dibuat oleh Doxygen dapat berupa html, LaTeX, serta beberapa format lainnya.

Sebagai gambaran, anda dapat membuat kode bahasa C seperti berikut.

/**
* Fungsi untuk menjumlahkan dua bilangan
* @param[in] nilai1 argumen yang menyimpan nilai pertama untuk dijumlahkan
* @param[in] nilai2 argumen yang menyimpan nilai kedua untuk dijumlahkan
* @return nilai1 + nilai2
* @sa pengurangan, perkalian, pembagian
*/
int penjumlahan(int nilai1, int nilai2);

Dengan Doxygen, kode program tersebut dapat di-parsing dan dapat dihasilkan tampilan html seperti kedua gambar di bawah.

Screenshot hasil dokumentasi html bagian 1

Screenshot hasil dokumentasi html bagian 1

Screenshot hasil dokumentasi html bagian 2

Screenshot hasil dokumentasi html bagian 2

Untuk mendapatkan program ini, silakan di-download di http://www.doxygen.org/. Sebelum memulai menggunakan program ini, disarankan untuk membaca bagian Getting started pada Doxygen manual. Selamat mencoba! :D

Catatan, Lisensi Doxygen: GPL.

Source : baguspewe.wordpress.com