Jumat, 22 Agustus 2014

Javadoc sebagai standar dokumentasi industri software

Java sebagai bahasa murni berorientasi objek mempunyai aturan yang ketat tentang penerapannya. Aturan-aturan yang ketat ini menjadikan Java sebagai bahasa yang populer karena keteraturannya. Java juga mengembangkan J2EE yang dikenal sebagai Java 2 Platform, Enterprise Edition. Dengan ini, Java mengklaim dan memang mengkhususkan untuk pengembangan aplikasi dengan skala besar.

Aplikasi dengan skala besar tentunya membutuhkan dokumentasi yang sangat baik sebagai sumber pengelolaan aplikasi. Dengan dokumentasi yang baik, setiap programmer dapat menggunakan kembali (reusable) Class yang telah dibuat bahkan untuk aplikasi yang lain.


Jadi, apa itu Javadoc?

Javadoc adalah dokumentasi generator dari Oracle Corporation untuk menghasilkan dokumentasi API dalam format HTML pada source code Java.

Dari sejarah awal pengembangan Java, Java telah menerapkan javadoc ini. Begitu terstruktur dan rapi arsitektur Java sehingga banyak bahasa lain juga mulai menerapkannya.

Pada IDE yang canggih seperti Netbeans dan Eclipse, Javadoc hadir dalam bentuk popup informasi sehingga programmer tidak perlu membaca halaman html. Untuk IDE yang tidak memiliki fitur javadoc atau text editor biasa, maka programmer buth javadoc (dalam format HTML).


Bagaimanakah bentuk Javadoc itu?

Karena Javadoc dalam bentuk HTML, dokumentasi tersebut dapat kita jumpai banyak di internet. Salah satu bentuk Javadoc seperti screenshot berikut




Bagaimana cara menulis Javadoc?

Dokumentasi lengkap pada Javadoc dapat ditemukan pada website Oracle berikut: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Secara sederhana, penulisan Javadoc terlihat seperti gambar berikut;



Pada IDE yang sudah memiliki fitur Javadoc akan memiliki popup untuk menampilkannya seperti berikut;




Bagaimana cara menghasilkan Javadoc?

Untuk menghasilkan Javadoc, tentunya berbeda-beda untuk setiap IDE.

Saat ini saya sedang bekerja dengan Eclipse IDE sehingga saya akan menjelaskan langkah cara menghasilkan Javadoc dengan Eclipse.

1. Pilih project yang akan di generate Javadoc-nya

2. Pada bagian menu: Project - Generate Javadoc

3. Ikuti saja langkah demi langkah yang disajikan oleh eclipse

4. Hasil akhir akan terlihat seperti berikut;





Penutup

Aplikasi bukanlah sebuah barang yang bisa usang. Membuat aplikasi tidak dimulai langsung sempurna. Aplikasi senantiasa diperbarui dengan berbagai macam alasan. Jika dokumentasi yang dihasilkan baik, rapi dan memiliki standar penulisan yang baku, maka pengembangan aplikasi menjadi lebih besar dan komplek akan terus terjaga.


Referensi

- http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
- http://en.wikipedia.org/wiki/Javadoc