Week 13: Java Documentation

Definisi

Javadoc, dengan bantuan JDK (Java Development Kit), adalah tool yang digunakan untuk membuat dokumentasi kode Java dalam format HTML dari source code Java yang ada, dimana dokumentasi ini telah ditentukan formatnya. Bahasa Java mendukung 3 (tiga) jenis komentar, yaitu sebagai berikut:

// Teks Dengan format ini, compiler mengabaikan teks yang dimulai dari // sampai akhir baris.

/* * Teks */ Dengan format ini, compiler mengabaikan teks yang dimulai dari /* sampai */, perbedaan dengan yang format sebelumnya, yaitu dengan format //, adalah format ini dapat berisi komentar dengan lebih dari satu baris.

/** * Dokumentasi */ Format ini adalah komentar dokumentasi, atau yang biasa disebut doc comment. Dengan format ini, JDK Javadoc akan menyiapkan dokumentasi yang dibuat secara otomatis.

Implementasi

Pada source code yang telah dibuat, telah dibuat Javadoc-nya, berikut ialah contoh tampilan Javadoc pada salah satu source code.

Dari hasil dokumentasi dengan format doc comment tersebut, kemudian dapat di-generate secara otomatis, seperti pada tampilan berikut:

Sekian yang dapat dituliskan, semoga kedepannya proses pengembangan aplikasi dapat berjalan dengan lancar dan semoga ilmu yang didapatkan dapat berguna dengan sebagaimana mestinya.

Salam, Betty Nauli Dina

Sumber - https://www.tutorialspoint.com/java/java_documentation.htm