Javadoc

1. Penjelasan

Java memiliki tools untuk mengekstrak dokumen yang ada pada file Java. Komentar yang harus diekstrak harus ditulis dalam format tertentu. Komentar ditulis seperti berikut diawali /** (slash bintang bintang) dan ditutup dengan */ (bintang slash). Setiap baris diawali dengan /* (slash bintang). Isi komentar boleh mengandung tag HTML. Untuk lebih jelasnya lihat  contoh.

Compile program tersebut dengan cara sebagai berikut :

2. Ketentuan

Ketentuan dalam menulis javadoc , antara lain :
- Komentar kelas
  Komentar diberikan tepat sebelum deklarasi kelas
- Gunakan tag @author untuk menulis nama pembuat
  Contoh :
   /**
   * Kelas Point adalah kelas yang merepresentasikan titik dalam koordinat kartesian
   * Kelas ini <b>tidak</b> menangani rotasi
   * @author kelompok enan
   */
   public class Point {
   }
- Komentar method ditukis tepat sebelum deklarasi method :
  - Gunakana tag @param untuk menjelaskan parameter (@param diikuti nama parameter lalu penjelasan parameter)
  - Gunakan tag @return untuk menjelaskan hasil kembalian method
  - Gunakan tag @see untuk member link method lain yang perlu dilihat
  - Tidak semua tag perlu dipakai
    contoh :
     /**
     * Method untuk memeriksa apakah point berada dalam kotak
     * @param k kotak yang diperiksa
     * @return true jika point berada di dalam kotak, false jika di luar kotak
     * @see jarak
     */
     boolean didalam(Kotak k){
     }