Komentar Jawa

Komentar adalah bagian dari program yang tidak dijalankan. Kompiler mengabaikan komentar karena tidak dimaksudkan untuk itu. Mereka ditulis dalam bahasa “manusia” dan dimaksudkan untuk menjelaskan program, bagian dari program, satu baris atau metode untuk pengembang atau orang yang terlibat dalam pengembangan. Paling sering, komentar ditulis dalam bahasa Inggris, itu semacam tradisi. Pada artikel ini, kita akan membahas tentang komentar di Java dan cara menggunakannya dengan benar untuk membuat hidup Anda dan rekan satu tim lebih mudah.

Komentar Java: mengapa itu penting

Mereka mengatakan programmer sangat malas mengomentari kode mereka sendiri. Namun, ini adalah keterampilan yang sangat penting, jadi jangan meremehkannya, meskipun Anda baru mulai belajar Java. Kode yang diberi komentar baik jauh lebih berharga daripada kode tanpa komentar karena program seperti itu lebih mudah dipelihara. Karena proyek besar paling sering ditulis dalam Java, komentar yang kompeten juga mempercepat pengembangan, karena lebih mudah bagi programmer untuk menangani kode orang lain. Komentar diperlukan untuk:

Pahami kodenya. Milikmu atau milik orang lain. Jika Anda merasa tidak perlu menguraikan kode Anda sendiri karena Anda yang menulisnya, coba buka program yang relatif rumit yang Anda tulis sebulan yang lalu atau bahkan lebih awal dan segera pahami apa, di mana, dan mengapa yang Anda pikirkan. Komentar dapat digunakan untuk menjelaskan logika suatu program atau blok suatu program, serta memberikan rekomendasi bagi mereka yang akan bekerja dengan kode Anda nanti. Jenis komentar ini bisa disebut penjelasan.
Berisi informasi tentang tujuan objek, parameter masukan dan keluaran (jika ada), data tentang pengembang, dan hal penting lainnya terkait dengan penggalan kode. Komentar tersebut terletak di header modul, perpustakaan, prosedur, dan fungsi. Itu bisa disebut komentar dokumentasi.
Kendalikan bug dan tingkatkan kode. Kode yang dipertanyakan atau kode yang memerlukan perbaikan selalu dapat dikomentari dan ditinjau kembali nanti. Jika terpikir oleh Anda bahwa masalah tertentu dapat diselesaikan dengan cara lain, tetapi sekarang Anda tidak punya waktu untuk itu, tulis ide ini di komentar. Jika tidak, kemungkinan besar, di bawah tekanan kode baru, Anda akan melupakannya.

Jenis komentar di Java

Meskipun Anda dapat menulis apa saja di komentar, ada beberapa jenis komentar di Java dan aturan penggunaannya. Di Java, komentarnya dingin:

Komentar satu baris
Komentar multi baris
Komentar dokumentasi

Komentar satu baris

Komentar Java yang paling umum adalah komentar satu baris. Untuk menunjukkan komentar seperti itu, cukup memberi tanda garis miring ganda sebelum teks // . Komentar satu baris hanya ditandai di awal komentar. Komentar berlanjut hingga akhir baris. Sintaksis:

//here is a single line comment.

Mari kita ambil contoh komentar Java jenis ini:

public class CommentsDemo1 {
   public static void main(String[] args) {
       System.out.println("This text is visible for Java compiler");
       //this text is single line comment
//This one is also single line comment
//they both (and me) are invisible for compiler
   }
}

Outputnya adalah:

Teks ini terlihat untuk kompiler Java

Biasanya komentar satu baris terletak di atas atau di bawah tempat yang dikomentari dalam program, kadang-kadang pada baris yang sama. Penting agar jelas secara visual apa maksud dari komentar tersebut.

Komentar Multi-baris

Terkadang satu baris tidak cukup untuk menulis komentar Java. Misalnya, Anda perlu menjelaskan cara kerja suatu metode atau rumus kompleks yang Anda terapkan. Dalam hal ini, Anda dapat menulis beberapa komentar satu baris, tetapi akan lebih rasional jika menulis apa yang disebut komentar multi-baris. Kedua sisinya ditandai dengan simbol /* */ . Sintaks komentar multi-baris:

/*This comment
is
Multi line comment
we can describe here
what we need */

Mari kita lihat contoh komentar multi-baris dalam kode

public class RleTest {

   /*
   Run Length Encoding (RLE),  a data compression algorithm
   that replaces repeated characters (series)
   with one character and the number of its repetitions.

   this method is to decode a String using run-length encoding

    */
   private static String decodeRle(String encoded) {
       if (encoded.isBlank()) return "";
       StringBuilder result = new StringBuilder();
       int count = 0;
       char baseChar = encoded.charAt(0);
       for (int i = 1; i <= encoded.length(); i++) {
           char c = i == encoded.length() ? '$' : encoded.charAt(i);
           if (Character.isDigit(c)) {
               count = count * 10 + Character.digit(c, 10);
           } else {
               do {
                   result.append(baseChar);
                   count--;
               } while (count > 0);
               count = 0;
               baseChar = c;
           }
       }
       return result.toString();
   }
   public static void main(String[] args) {
       System.out.println(decodeRle("C3ecddf8"));
   }
}

Komentar Dokumentasi Java

Ini adalah jenis komentar Java khusus yang digunakan untuk menghasilkan halaman dokumentasi. Biasanya pengembang menulis komentar dokumentasi menggunakan Javadoc, generator dokumentasi untuk menghasilkan dokumentasi API dalam format HTML dari kode sumber Java. Format dokumen yang digunakan oleh Javadoc adalah standar industri untuk mendokumentasikan kelas Java dan IDE terpopuler seperti IntelliJ IDEA dan Eclipse, secara otomatis menghasilkan Javadoc HTML. Komentar dokumentasi Java memiliki sintaks di bawah ini:

/**
Some important Javadoc comments here
You don’t know it yet, but Javadoc rulez

@author  Java Developer
*/

Berikut ini contohnya: ini adalah bagian dari kelas Java Short . Omong-omong, Anda dapat melihat kode kelas Java apa pun dari IDE Anda (misalnya di IntelliJ IDEA dari Windows cukup tekan ctrl+LBM atau ctrl + b (di Windows) pada nama kelas atau metode apa pun).

package java.lang;

import jdk.internal.HotSpotIntrinsicCandidate;
import jdk.internal.misc.VM;

/**
* The {@code Short} class wraps a value of primitive type {@code
* short} in an object.  An object of type {@code Short} contains a
* single field whose type is {@code short}.
*
* <p>In addition, this class provides several methods for converting
* a {@code short} to a {@code String} and a {@code String} to a
* {@code short}, as well as other constants and methods useful when
* dealing with a {@code short}.
*
* @author  Nakul Saraiya
* @author  Joseph D. Darcy
* @see     java.lang.Number
* @since   1.1
*/
public final class Short extends Number implements Comparable<Short> {

   /**
    * A constant holding the minimum value a {@code short} can
    * have, -2<sup>15</sup>.
    */
   public static final short   MIN_VALUE = -32768;

   /**
    * A constant holding the maximum value a {@code short} can
    * have, 2<sup>15</sup>-1.
    */
   public static final short   MAX_VALUE = 32767;

   /**
    * The {@code Class} instance representing the primitive type
    * {@code short}.
    */
   @SuppressWarnings("unchecked")

Berikut adalah kode Java dari metode println() yang terkenal dan disukai semua pemula dengan komentar seperti itu:

/**
* Prints a String and then terminate the line.  This method behaves as
* though it invokes {@link #print(String)} and then
* {@link #println()}.
*
* @param x  The {@code String} to be printed.
*/
public void println(String x) {
   if (getClass() == PrintStream.class) {
       writeln(String.valueOf(x));
   } else {
       synchronized (this) {
           print(x);
           newLine();
       }
   }
}

Javadoc memiliki beberapa tag Javadoc khusus yang ditandai dengan @ dapat Anda lihat pada kode di atas. Contoh tag Javadoc adalah @author yang menambahkan nama penulis kelas. Tag Javadoc lainnya adalah @karena menambahkan komentar yang menunjukkan bahwa kelas ini digunakan sejak versi Java yang ditentukan. Menulis dokumen Javadoc yang baik memerlukan pengetahuan dan pengalaman (dan kesabaran!). Anda dapat menemukan informasi lebih lanjut tentang Javadoc di dokumentasi resmi Cara Menulis Komentar Dokumen untuk Alat Javadoc .

PS beberapa contoh komentar lucu dari kehidupan nyata

/**
*Dear Maintainer
*
*Once you are done trying to 'optimize' this routine,
*and you have realized what a terrible mistake that was,
*please increment the following counter as a warning
*to the next guy.
*
*total_hours_wasted_here = 73
*/

Exception up = new Exception("Something is really wrong.");
throw up;  //ha ha

// When I wrote this, only God and I understood what I was doing
// Now, God only knows

// sometimes I believe compiler ignores all my comments

/**
Always returns true.
*/
public boolean isAvailable() {
return false;
}

Untuk memperkuat apa yang Anda pelajari, kami sarankan Anda menonton video pelajaran dari Kursus Java kami