Salah satu cara terpenting untuk meningkatkan keterbacaan program Anda adalah dengan menggunakan komentar. Komentar adalah informasi yang disertakan dalam sebuah program hanya untuk kepentingan manusia yang mencoba mencari tahu apa yang terjadi dalam program tersebut. Kompiler Java mengabaikan komentar sepenuhnya saat menyiapkan versi runnable dari file sumber Java.
Ada tiga jenis komentar berbeda yang dapat Anda gunakan dalam program Java, dan Anda dapat menggunakan masing-masingnya sesuai kebijaksanaan Anda.
Cara pertama untuk menambahkan komentar ke program adalah dengan mengawalinya dengan dua karakter garis miring (“//”). Segala sesuatu mulai dari garis miring hingga akhir baris dianggap sebagai komentar dan diabaikan oleh kompiler Java, seperti dalam pernyataan berikut:
int jam kredit = 3; // mengatur jam kredit untuk kursus Jika Anda perlu membuat komentar yang membutuhkan lebih dari satu baris, Anda dapat memulainya dengan teks “/*” dan mengakhirinya dengan teks “*/”. Segala sesuatu di antara kedua pembatas ini dianggap sebagai komentar, seperti berikut ini:
/* Program ini terkadang menghapus semua file di hard drive Anda dan menjadikannya tidak dapat digunakan sama sekali saat Anda menekan tombol Simpan. */
Jenis komentar terakhir dimaksudkan agar dapat dibaca oleh komputer dan juga dapat dibaca oleh manusia.
Jika Anda memulai komentar dengan teks “/**” (bukan “/*”) dan mengakhirinya dengan “*/”, komentar tersebut ditafsirkan sebagai dokumentasi resmi tentang cara kerja kelas dan metodenya.
Komentar semacam ini kemudian dapat dibaca oleh utilitas seperti alat javadoc yang disertakan dengan JDK. Program javadoc menggunakan komentar resmi untuk membuat sekumpulan catatan Hypertext Markup Language (HTML) yang mendokumentasikan program, hierarki kelasnya, dan metodenya. Informasi lebih lanjut tersedia di javadoc di Lampiran B, “Pemrograman dengan Java Development Kit.”