Netbeans Tips n Trick : Menambahkan Source dan Javadoc sebuah Library
Source code dan Java documentation adalah material terpenting untuk memahami kode sumber java. Untuk mencari tahu bagaimana API sebuah library disusun, seringkali saya harus bolak-balik membuka jendela firefox untuk melihat java documentation dari library, atau paling sering java documentation JDK. Pekerjaan ini sebenernya tidak terlalu susah, tapi karena saking seringnya jadi menyebalkan.
Malah terkadang saya harus membongkar(hack) kode program library untuk melihat bagaimana API tersebut diimplementasikan. Kalau kodenya ada di luar netbeans, saya harus membuka file java-nya menggunakan text editor, pekerjaan yang tidak menyenangkan.
Untungnya Netbeans menyediakan fasilitas untuk menyertakan kode sumber dan java documentation sebuah libary. Dengan adanya fasilitas ini, kita bisa melihat java documentation dari code completion, seperti terlihat di gambar ini :
Kita juga bisa melihat kode sumber dari library dengan menekan shortcut ALT + G, atau dengan menekan tombol CTRL + Left-click diatas class yang akan dilihat kode sumbernya.
Untuk menggunakan fasilitas tersebut kita tentu saja memerlukan kode sumber library dan Java documentation Library. Nah misalnya kalau kode sumber ada tapi library providernya tidak menyediakan java documentation bagaimana? tenang, ada tools javadoc dari JDK yang bisa dugunakan untuk men-generate java documentation dari kode sumber java.
Pertama anda harus memastikan kode sumber dalam keadaan terekstraksi, jika masih dibungkus dalam file zip atau file jar, maka anda perlu mengekstrak kode sumber dalam folder. Secara umum kode sumber biasanya diletakkan dalam folder src, library jar diletakkan dalam folder lib, berikut ini perintah untuk men-generate java documentation menggunakan tools javadoc :
Linux command :
shell$ javadoc -sourcepath src -subpackages org:com -d docs -classpath lib/*:
Windows command :
prompt\> javadoc -sourcepath src -subpackages org;com -d docs -classpath lib/*;
Keterangan :
- -sourcepath digunakan untuk mendefinisikan di folder mana kode sumber berada
- -subpackages digunakan untuk mendefinisikan package yang ada dalam source, cukup sebutkan package yang berada tepat di bawah folder src
- -d mendefinisikan di folder mana file hasil generate javadoc akan diletakkan
- -classpath option ini digunakan jika kode sumber memerlukan library tambahan, simbol wildcard (*) untuk menerangkan bahwa semua file jar di dalam folder lib akan dimasukkan dalam classpath (wildcard available only in java 6!)
Hasil generate tools javadoc akan terlihat seperti gambar di bawah ini :
Dalam contoh ini saya menggunakan kasus hibernate, jadi saya menyediakan :
- File jar hibernate (hibernate3.jar)
- Kode sumber hibernate (berada dalam folder src)
- Java documentation hibernate (berada dalam folder docs)
Kita siap untuk membuat "Library" hibernate dalam netbeans. Sekarang kita akan menampilkan jendela library manager, pilih menu :
Tools > Library Manager
atau Klik kanan di folder Libraries pada jendela project seperti gambar di bawah ini :
Kemudian pilih menu Add Library, bukan Add Jar/Folder. Jika anda memilih menu Add Jar/Folder, maka anda tidak dapat menambahkan kode sumber dan java documentation untuk jar/folder tersebut. Setelah berhasil menampilkan jendela library manager, langkah berikutnya adalah membuat library baru, kemudian masukkan file hibernage3.jar, selanjutnya adalah menambahkan folder src ke dalam Library Source dan folder docs ke Library Javadoc, seperti terlihat dalam gambar di bawah ini :
Sampai disini anda telah berhasil menambahkan kode sumber dan javadoc ke dalam classpath library, sehingga anda bisa menggunakan fasilitas Javadoc viewer ketika code completion tampil. Selain library, kita juga dapat menambahkan kode sumber dan javadoc ke JDK platform. Yang anda perlukan adalah kode sumber untuk JDK dan Javadoc. Setelah keduanya diperoleh, langkah menambahkanya ke dalam JDK Platform classpath sangat gampang. Plih menu :
Tools > Java Platform Manager
Kemudian jendela Java Platform Manager akan muncul, dan anda tinggal memasukkan kode sumber JDK dan JDK java documentation seperti terlihat dalam gambar di bawah ini :
Nah, gampang bukan? silahkan dicoba di Netbeans masing-masing, jika ada pertanyaan kritik atau saran jangan sungkan-sungkan meninggalkan comment di post ini.
Semoga bermanfaat,
Regards
06:14PM 11 Apr 2007 dalam kategori Netbeans oleh ifnu Comments[3]
Ini gw, 
kk saya dah pernah nyobain cara itu biar si JDKnya nampilin JAvaDocnya pas code completion tp ga b'hasil
pas ngetik java. trus muncul code comlpetionnya nah disitu ga tampil javadocnya knp...?
Posted by Ryan on April 24, 2007 at 09:19 AM WIT #
ada kemungkinan java doc yang km masukkan tidak sesuai dengan JDK yang km pakai, coba cek lagi apakah JDK dan Javadocnya mempunyai versi yang sama. kemudian setelah selesai masang javadocnya restart netbeans, moga2 berhasil :D
Posted by ifnu on April 25, 2007 at 12:03 PM WIT #
good job.
Posted by ivan on July 22, 2007 at 03:59 PM WIT #