Menghasilkan Javadoc di Eclipse

Sudah bertahun-tahun saya membaca hasil dokumentasi Javadoc dari berbagai aplikasi open source terutama Pentaho. Namun sebagai programmer Java sendiri, saya belum pernah menerapkan Javadoc ini dalam aplikasi internal.

Setelah seminggu ini  mencoba, akhirnya hal sederhana namun penting ini dapat terealisasikan di source code Java saya. Nah, berikut adalah sharing saya tentang penggunaan Javadoc ini di Eclipse.

Sekilas Javadoc

Javadoc adalah utilitas dari JDK (Java Development Kit) yang melakukan proses otomatisasi menghasilkan dokumentasi API dari comments atau remarks yang kita tambahkan di source code kita. Dokumentasi yang dihasilkan berupa halaman web (format HTML). 

Contoh halaman Javadoc API untuk Java 1.5 dapat dilihat disini. Terlihat pada halaman web tersebut daftar package, class dan keterangan detil dari tiap menu yang dipilih di panel kanan.

Javadoc di Eclipse

Oke, jika pembaca sudah memiliki gambaran apa itu Javadoc maka berikut ini saya memiliki project yang akan saya generate menjadi halaman Javadoc. Project saya di Eclipse versi 3.5.2 terlihat sebagai berikut di panel package explorer.

Tahap-tahap untuk menghasilkan dokumentasi Javadoc untuk project tersebut adalah sebagai berikut :

• Pilih menu Project | Generate Javadoc

• Pada dialog yang muncul, masukkan lokasi utilitas javadoc. Pilih juga package / class yang kita ingin dokumentasikan. Terakhir masukkan lokasi folder output.
• Klik tombol "Next" jika sudah selesai.
  
  
  
  
  
  
  
• Pada dialog berikutnya masukkan judul dokumentasi. Klik "Finish" saja untuk tahap ini.
  
  
  
  
  
  
  
  
  
• Pada console Eclipse akan terlihat proses generate-nya. Tunggu sampai selesai.

• Lihat hasilnya pada folder output yang kita spesifikasikan sebelumnya. Buka index.html sebagai tampilan halaman awal.

• Selesai

Referensi

• http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
• http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html