Teks Komentar Pada Bahasa Pemrograman Java

Komentar pada bahasa pemrograman mengambil peran dalam membuat program menjadi lebih mudah dibaca oleh manusia dengan cara menempatkan rincian pada kode program pada bagian program yang terlibat sehingga program lebih mudah untuk dipelihara dan lebih mudah untuk dilakukan debugging. Komentar yang ditulis di dalam bahasa pemrograman akan diabaikan oleh compiler ketika proses kompilasi pada pada sebuah bahasa pemrograman.

Pada bahasa pemrograman Java terdapat tiga jenis teks komentar:
satu, single - komentar sebaris.
dua, multi - komentar lebih dari satu baris.
tiga, Komentar dokumentasi.

Teks Komentar Sebaris
Programmer level pemula biasanya menggunakan teks komentar sebaris untuk mendeskripsikan fungsi dari kode program. Teks komentar ini adalah bentuk paling mudah dan sederhana untuk digunakan.

Sintak:
// Berikan komentar disini ( Teks dalam baris ini akan dianggap sebagai Teks komentar )

Contoh program:

// Program java memperlihatkan teks komentar satu baris 

class Scomment 
{ 
public static void main(String args[]) 
{ 

// Teks komentar sebaris

System.out.println("Single line comment above"); 
} 
} 

Teks komentar multi baris
Digunakan untuk mendeskripsikan method secara penuh pada baris program atau potongan dari baris program yang komplek tanpa perlu menambahkan '//' pada tiap baris baru.

Sintak:
/* Awal teks komentar
komentar selanjutnya
komentar selanjutnya
.
.
.
akhir teks komentar */

Contoh program:

// Program Java memperlihatkan teks komentar multi baris class Scomment { public static void main(String args[]) { System.out.println("Multi line comments below"); /* teks komentar baris 1 teks komentar baris 2 teks komentar baris 3*/ } }

Dapat juga digunakan untuk teks komentar satu baris seperti contoh berikut ini:
/* Komentar baris 1 */

Teks komentar dokumentasi
Tipe teks komentar ini umumnya digunakan ketika menulis kode program untuk project atau package perangkat lunak. Teks komentar dokumentasi membantu untuk menghasilkan dokumentasi referensi yang dapat digunakan untuk mendapatkan informasi tentang method, parameter, dan lainnya.

Sintak:
/** Teks komentar dimulai
*
* tags digunakan untuk memesan parameter spesifik
* atau method dan heading
* HTML tags juga dapat digunakan 
* seperti <h1>
*
* akhir teks komentar*/

Beberapa tag yang dapat digunakan pada teks komentar dokumentasi.
catatan: Penggunaan dari tag akan dapat digunakan secara otomatis pada software compiler. Jika pembuatan class Java menggunakan notepad maka fungsi dari komentar dokumentasi tidak akan terlihat kegunaannya.

satu, Menambahkan nama author dalam class Java. sintak: @author name-text

dua, Menampilkan teks dalam huruf tanpa menerjemahkan sebagai teks HTML atau tag javadoc nested. sintak: {@code text}

tiga, Menampilkan jalur relatif dari hasil dokumentasi jalur penyimpanan pada hasil halaman apapun. sintak: {@docRoot}

empat, Menambahkan komentar yang mengindikasikan API tidak lagi digunakan. sintak: @deprecated deprecatedtext

lima, Menambahkan subheading throw pada dokumentasi yang dihasilkan, dengan nama class dan deskripsi teks. sintak: @exception class-name description

enam, Mewariskan komentar dari class turunan atau implementasi interface terdekat. sintak: Inherits a comment from the immediate surperclass

tujuh, Menambahkan baris link dengan visible teks label yang dituju ke dokumentasi untuk package spesifik, class, atau anggota nama dari class referensi. sintak: {@link package.class#member label}

delapan, Sama seperti {@link}, kecuali pada penggunaan link label yang ditampilkan pada plain teks kemudian kode huruf. sintak: {@linkplain package.class#member label}

sembilan, Menambahkan parameter dengan nama parameter spesifik yang diikuti oleh deskripsi spesifik untuk parameter-parameter section. sintak:  @param parameter-name description

sepuluh, Menambahkan return section dengan deksripsi teks. sintak: @return description

sebelas, Menambahkan "See Also" beserta link atau teks yang mengacu pada referensi yang dituju. sintak: @see reference

dua_belas, Digunakan dalam komentar dokumen untuk bidang serialisasi otomatis. sintak: @serial field-description | include | exclude

tiga_belas, Dokumentasi dari data yang ditulis oleh method writeObject() atau writeExternal(). sintak: @serialData data-description

empat_belas, Dokumentasi dari komponen ObjectStreamFiel. sintak: @serialField field-name field-type field-description

lima_belas, Menambahkan "Since" heading dengan spesifikasi teks waktu untuk hasil dokumentasi. sintak: @since release

enam_belas, Penggunaan @throws dan @exception tag adalah sama. sintak: @throws class-name description

tujuh_belas, Ketika {@value} digunakan dalam komentar dokumen dari bidang statis, maka akan menampilkan nilai dari konstanta. sintak: {@value package.class#field}

delapan_belas, Menambahkan "Version" subheading dengan spesifikasi teks versi menuju hasil dokumentasi ketika "version" digunakan. sintak: @version version-text


Contoh Program:

// Program Java mengilustrasikan periode penggunaan // dari tag-tag komentar /** * <h1> menemukan nilai rata-rata dari tiga nilai!</h1> * program FindAvg program implements pada applikasi sederhana * yang menghitung nilai rata-rata dari tiga bilangan integer * dan mencetak hasilnya pada layar monitor * * @author Elfan Mauludi * @version 1.0 * @since 2019-03-18 */ public class FindAvg { /** * Method ini digunakan untuk mencari nilai rata-rata dari tiga bilangan integer. * @param numA parameter pertama untuk method findAvg * @param numB paramater kedua untuk method findAvg * @param numC parameter ketiga untuk method findAvg * @return int mengembalikan nilai rata-rata dari numA, numB, dan numC. */ public int findAvg(int numA, int numB, int numC) { return (numA + numB + numC)/3; } /** * method utama membuat method findAvg method dapat dijalankan. * @param args tidak digunakan. * @return tidak mengembalikan nilai apapun. */ public static void main(String args[]) { FindAvg obj = new FindAvg(); int avg = obj.findAvg(10, 20, 30); System.out.println("Average of 10, 20 and 30 is :" + avg); } }

Output:
Average of 10, 20 and 30 is :20

Code dokumentasi pada contoh program sebelumnya dihasilkan menggunakan tools 'javadoc'. Javadoc dapat dijalankan dengan cara menggunakan perintah berikut ini pada cmd.
javadoc FindAvg.java