Cara Menggunakan Komentar dalam Kode Java

ThoughtcoMar 07, 2020

Komentar Java adalah catatan dalam file kode Java yang diabaikan oleh kompiler dan mesin runtime. Mereka digunakan untuk membubuhi keterangan kode untuk memperjelas desain dan tujuannya. Anda dapat menambahkan komentar dalam jumlah tak terbatas ke file Java, tetapi ada beberapa "praktik terbaik" untuk diikuti saat menggunakan komentar.

Secara umum, komentar kode adalah komentar "implementasi" yang menjelaskan Kode sumber, seperti deskripsi kelas, antarmuka, metode, dan bidang. Ini biasanya beberapa baris yang ditulis di atas atau di samping kode Java untuk memperjelas apa yang dilakukannya.

Tipe lain dari komentar Java adalah komentar Javadoc. Komentar Javadoc sedikit berbeda dalam sintaksis dari komentar implementasi dan digunakan oleh program javadoc.exe untuk menghasilkan dokumentasi Java HTML.

Mengapa Menggunakan Komentar Java?

Merupakan praktik yang baik untuk membiasakan diri memasukkan komentar Java ke dalam kode sumber Anda untuk meningkatkan keterbacaan dan kejelasannya untuk Anda dan programmer lainnya. Tidak selalu jelas apa yang sedang dilakukan bagian kode Java. Beberapa baris penjelasan dapat secara drastis mengurangi jumlah waktu yang diperlukan untuk memahami kode.

instagram viewer

Apakah Mereka Mempengaruhi Bagaimana Program Berjalan?

Komentar implementasi di Kode Java hanya ada di sana untuk dibaca manusia. Kompiler Java tidak peduli tentang mereka dan kapan menyusun program, mereka hanya melewati mereka. Ukuran dan efisiensi program terkompilasi Anda tidak akan terpengaruh oleh jumlah komentar dalam kode sumber Anda.

Komentar Implementasi

Komentar implementasi hadir dalam dua format berbeda:

  • Komentar Baris: Untuk komentar satu baris, ketik "//" dan ikuti dua garis miring ke depan dengan komentar Anda. Sebagai contoh: 
     // ini adalah komentar satu baris
    int guessNumber = (int) (Math.random () * 10);
    Ketika kompilator menemukan dua garis miring ke depan, ia tahu bahwa segala sesuatu di sebelah kanannya harus dianggap sebagai komentar. Ini berguna saat men-debug sepotong kode. Cukup tambahkan komentar dari sederet kode yang Anda debug, dan kompiler tidak akan melihatnya:
    •  // ini adalah komentar satu baris
      // int guessNumber = (int) (Math.random () * 10);
      Anda juga dapat menggunakan dua garis miring ke depan untuk membuat komentar akhir baris:
    •  // ini adalah komentar satu baris
      int guessNumber = (int) (Math.random () * 10); // Komentar akhir baris
  • Blokir Komentar: Untuk memulai komentar blokir, ketik "/ *". Segala sesuatu di antara garis miring ke depan dan tanda bintang, meskipun berada pada baris yang berbeda, diperlakukan sebagai komentar hingga karakter "* /" mengakhiri komentar. Sebagai contoh: 
     / * ini 
    adalah 
    Sebuah
    blok
    komentar
    */
    / * begitu juga ini * /

Komentar Javadoc

Gunakan komentar Javadoc khusus untuk mendokumentasikan API Java Anda. Javadoc adalah alat yang disertakan dengan JDK yang menghasilkan dokumentasi HTML dari komentar dalam kode sumber.

Sebuah komentar Javadoc di 

.Jawa
file sumber terlampir dalam sintaks mulai dan akhiri seperti: 
/**
dan 
*/
. Setiap komentar di dalam ini diawali dengan a 
*
.

Tempatkan komentar ini tepat di atas metode, kelas, konstruktor, atau elemen Java lainnya yang ingin Anda dokumentasikan. Sebagai contoh:

// myClass.java
/**
* Jadikan ini ringkasan kalimat yang menggambarkan kelas Anda.
* Ini baris lain.
*/
publikkelas kelasku
{
...
}

Javadoc menggabungkan berbagai tag yang mengontrol bagaimana dokumentasi dihasilkan. Misalnya, 

@param
tag mendefinisikan parameter ke suatu metode: 
 / ** metode utama
* @param args String []
*/​
publikstatiskosong main (String [] args)
​{
System.out.println ("Hello World!");
}

Banyak tag lain tersedia di Javadoc, dan itu juga mendukung tag HTML untuk membantu mengontrol output. Lihat dokumentasi Java Anda untuk lebih detail.

Kiat untuk Menggunakan Komentar

  • Jangan berlebihan berkomentar. Setiap baris program Anda tidak perlu dijelaskan. Jika program Anda mengalir secara logis dan tidak ada yang tidak terduga terjadi, jangan merasa perlu untuk menambahkan komentar.
  • Indentasi komentar Anda. Jika baris kode yang Anda komentari adalah indentasi, pastikan komentar Anda cocok dengan indentasi tersebut.
  • Simpan komentar yang relevan. Beberapa programmer sangat baik dalam memodifikasi kode, tetapi karena beberapa alasan lupa untuk memperbarui komentar. Jika komentar tidak lagi berlaku, maka modifikasi atau hapuslah.
  • Jangan membuat sarang komentar blokir. Berikut ini akan menghasilkan kesalahan kompiler: 
     / * ini 
    adalah
    / * Komentar blokir ini menyelesaikan komentar pertama * /
    Sebuah
    blok
    komentar
    */
instagram story viewer