Membuat Komentar Java dan Fungsinya

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

Sebelum lebih lanjut mempelajari materi tentang cara Membuat Komentar Java dan Fungsinya, terlebih dahulu pelajari materi tentang: Deklarasi Forward Java dan Fungsinya, Konversi Tipe Data Java dan Fungsinya, dan Konversi Tipe Data Primitif Java dan Fungsi Lanjutan.

Komentar dalam pemrograman Java adalah bagian penting dari dokumentasi kode. Komentar membantu pengembang untuk menjelaskan fungsi, logika, atau tujuan dari bagian kode tertentu. Komentar juga membantu orang lain yang membaca kode untuk memahami alur kerja aplikasi. Dalam panduan ini, akan dibahas berbagai jenis komentar dalam Java beserta cara penggunaannya.

Pada bahasa pemrograman Java terdapat tiga jenis teks komentar:

• single - komentar sebaris.
• multi - komentar lebih dari satu baris.
• 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. Komentar satu baris adalah komentar yang dimulai dengan dua garis miring (//). Komentar ini hanya berlaku untuk satu baris kode.

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. Komentar multibaris dimulai dengan /* dan diakhiri dengan */. Komentar ini dapat mencakup beberapa baris kode.

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

Contoh:

// Program Java memperlihatkan

// teks komentar multi baris 

 

class Scomment 

{ 

 

public static void main(String args[]) 

{ 

System.out.println("Komentar"

+" multibaris diperlihatkan"

+" pada baris berikut."); 

 

/* 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 */

Baca Juga:

• Menuju Baris Tertentu pada Java Menggunakan Keyword Goto
• Nilai Null Java dan Fungsinya
• Menggunakan Underscore Untuk Nama Variabel Java dan Fungsinya
• Fungsi Currying Java dan Penerapannya

Teks Komentar Dokumentasi

Tipe teks komentar ini umumnya digunakan ketika menulis kode program untuk project atau package perangkat lunak. Teks komentar dokumentasi digunakan untuk membantu menghasilkan dokumentasi referensi yang dapat digunakan untuk mendapatkan informasi tentang keterangan dari fungsi method, parameter, dan lain sebagainya. Komentar dokumentasi dimulai dengan /** dan diakhiri dengan */. Komentar ini digunakan untuk menghasilkan dokumentasi otomatis menggunakan alat seperti Javadoc.

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

Teks Komentar TODO

Komentar TODO digunakan untuk menandai bagian kode yang perlu diselesaikan atau diperbaiki di masa depan.

Sintak:

// TODO: Perlu menangani kasus khusus di sini

Teks Komentar Penting

Komentar penting digunakan untuk menyoroti bagian kode yang penting atau perlu diperhatikan.

Sintak:

// ! Penting: Perhatikan batas waktu pada fungsi ini

Teks Komentar Penjelasan

Komentar penjelasan digunakan untuk memberikan penjelasan tambahan tentang kode yang kompleks atau sulit dipahami.

Sintak:

//? Apakah perlu menambahkan penanganan kesalahan di sini?

Teks Komentar Nonaktifkan Kode

Komentar digunakan untuk menonaktifkan bagian kode sementara tanpa menghapusnya.

Sintak:

/* 

kode yang dinonaktifkan sementara

System.out.println("Ini adalah kode yang dinonaktifkan");

*/

Beberapa Tag yang Dapat Digunakan pada Teks Komentar Dokumentasi

Penggunaan dari tag akan dapat digunakan secara otomatis pada kompilator perangakt lunak. Jika pembuatan class Java menggunakan notepad maka fungsi dari komentar dokumentasi tidak akan terlihat kegunaannya.

• Menambahkan nama author dalam class Java. sintak: @author name-text
• Menampilkan teks dalam huruf tanpa menerjemahkan sebagai teks HTML atau tag javadoc nested. sintak: {@code text}
• Menampilkan jalur relatif dari hasil dokumentasi jalur penyimpanan pada hasil halaman apapun. sintak: {@docRoot}
• Menambahkan komentar yang mengindikasikan API tidak lagi digunakan. sintak: @deprecated deprecatedtext
• Menambahkan subheading throw pada dokumentasi yang dihasilkan, dengan nama class dan deskripsi teks. sintak: @exception class-name description
• Mewariskan komentar dari class turunan atau implementasi interface terdekat. sintak: Inherits a comment from the immediate surperclass
• 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}
• Sama seperti {@link}, kecuali pada penggunaan link label yang ditampilkan pada plain teks kemudian kode huruf. sintak: {@linkplain package.class#member label}
• Menambahkan parameter dengan nama parameter spesifik yang diikuti oleh deskripsi spesifik untuk parameter-parameter section. sintak:  @param parameter-name description
• Menambahkan return section dengan deksripsi teks. sintak: @return description
• Menambahkan "See Also" beserta link atau teks yang mengacu pada referensi yang dituju. sintak: @see reference
• Digunakan dalam komentar dokumen untuk bidang serialisasi otomatis. sintak: @serial field-description | include | exclude
• Dokumentasi dari data yang ditulis oleh method writeObject() atau writeExternal(). sintak: @serialData data-description
• Dokumentasi dari komponen ObjectStreamFiel. sintak: @serialField field-name field-type field-description
• Menambahkan "Since" heading dengan spesifikasi teks waktu untuk hasil dokumentasi. sintak: @since release
• Penggunaan @throws dan @exception tag adalah sama. sintak: @throws class-name description
• Ketika {@value} digunakan dalam komentar dokumen dari bidang statis, maka akan menampilkan nilai dari konstanta. sintak: {@value package.class#field}
• Menambahkan "Version" subheading dengan spesifikasi teks versi menuju hasil dokumentasi ketika "version" digunakan. sintak: @version version-text

Contoh:

// 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("Nilai"

+" rata-rata dari 10, 20,"

+" dan 30 adalah :" 

+ avg); 

} 

}

Output:

Nilai rata-rata dari 10, 20, dan 30 adalah :20

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

Referensi Tambahan:

• Menggunakan Underscore Java Untuk Literasi Angka
• Program Pencarian pada Java Menggunakan Binary Search
• Program Pengurutan Data pada Java Menggunakan Sorting
• Class dan Object Java dan Fungsinya
• Alokasi Memori Java Objek dan Fungsinya
• Cara Menciptakan Objek Java dan Fungsinya
• Cara Bertukar Objek Java dan Fungsinya

Artikel ini didedikasikan kepada: Yuniar Pingkan Fitriannisa, Zahra Ayu Novitasari, Adela Dian Putri Herjati, Aditya Deva Hernanda, dan Anindya Gita Atina.

Location: Semarang, Kota Semarang, Jawa Tengah, Indonesia

Berbagi :