Dokumentasi Source Code Menggunakan Tools Doxygen

Doxygen logo

Doxygen logo

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!😀

Catatan, Lisensi Doxygen: GPL.

2 Balasan ke Dokumentasi Source Code Menggunakan Tools Doxygen

  1. waskita mengatakan:

    Saya juga pakai Doxygen untuk dokumentasi kerjaan-kerjaan serius. Untuk tugas kuliah yang dikumpul dalam 1 minggu memang gak perlu Doxygen, tapi untuk suatu produk software yang akan dipakai selama bertahun-tahun, wajib banget pakai dokumentasi seperti Doxygen ini.

  2. Andry Ongkinata mengatakan:

    wew, mbahnya dah berkomentar… Saya juga sedang mencoba menggunakannya. Hasilnya cukup memuaskan😀

Tinggalkan Balasan

Isikan data di bawah atau klik salah satu ikon untuk log in:

Logo WordPress.com

You are commenting using your WordPress.com account. Logout / Ubah )

Gambar Twitter

You are commenting using your Twitter account. Logout / Ubah )

Foto Facebook

You are commenting using your Facebook account. Logout / Ubah )

Foto Google+

You are commenting using your Google+ account. Logout / Ubah )

Connecting to %s

%d blogger menyukai ini: