KodeGym/Blog Jawa/Acak/Komentar Jawa
John Squirrels
tingkat
San Francisco

Komentar Jawa

Diterbitake ing grup
Komentar minangka bagean saka program sing ora dieksekusi. Compiler mung nglirwakake komentar amarga ora dimaksudake. Lagi ditulis ing "manungsa" basa lan dimaksudaké kanggo nerangake program, bagéan saka program, siji baris utawa cara kanggo gawe utawa wong melu pembangunan. Paling asring, komentar ditulis nganggo basa Inggris, iki minangka tradisi. Ing artikel iki, kita bakal ngomong babagan komentar ing basa Jawa lan cara nggunakake kanthi bener kanggo nggawe urip luwih gampang kanggo sampeyan lan kanca-kanca.

Jawa Komentar: kok padha penting

Padha ngomong programer banget kesed nalika nerangake komentar ing kode dhewe. Nanging, iki minangka katrampilan sing penting banget, mula aja disepelekake, sanajan sampeyan lagi sinau basa Jawa. Kode sing dikomentari kanthi apik luwih larang tinimbang kode tanpa komentar amarga program kasebut luwih gampang dijaga. Wiwit proyèk-proyèk gedhé paling kerep ditulis ing Jawa, komentar sing kompeten uga nyepetake pangembangan, amarga luwih gampang kanggo programmer kanggo ngatasi kode wong liya. Komentar dibutuhake kanggo:
  • Ngerti kode. Panjenengan utawa wong liya. Yen misale jek sampeyan ora perlu nerjemahake kode dhewe amarga sampeyan nulis, coba mbukak program sing relatif rumit sing sampeyan tulis sewulan kepungkur utawa malah sadurunge lan cepet ngerti apa, ing ngendi lan apa sing sampeyan pikirake. Komentar bisa digunakake kanggo nerangake logika program utawa blok program, uga menehi rekomendasi kanggo wong sing bakal nggarap kode sampeyan mengko. Jenis komentar iki bisa diarani panjelasan.

  • Ngemot informasi babagan tujuan obyek, paramèter input lan output (yen ana), data babagan pangembang, lan prekara penting liyane sing ana gandhengane karo fragmen kode. Komentar kasebut ana ing header modul, perpustakaan, prosedur, lan fungsi. Bisa kasebut komentar dokumentasi.

  • Ngontrol kewan omo lan nambah kode. Kode utawa kode sing bisa dipertanyakan sing mbutuhake perbaikan bisa tansah dikomentari lan dideleng maneh mengko. Yen sampeyan duwe masalah tartamtu bisa ditanggulangi kanthi cara sing beda, nanging saiki sampeyan ora duwe wektu, tulis ide iki ing komentar. Yen ora, paling kamungkinan, ing meksa kode anyar, sampeyan bakal lali bab iku.

Jinis komentar ing basa Jawa

Senadyan kasunyatan manawa sampeyan bisa nulis apa wae lan kabeh ing komentar, ana sawetara jinis komentar ing Jawa lan aturan kanggo nggunakake. Ing Jawa komentar kadhemen dadi:
  • Komentar siji baris
  • Komentar multi baris
  • Komentar dokumentasi

Komentar siji baris

Komentar Jawa sing paling umum yaiku komentar baris tunggal. Kanggo nunjukake komentar kasebut, cukup kanggo nyelehake garis miring kaping pindho sadurunge teks // . Komentar siji baris diwenehi tandha mung ing wiwitan komentar. Komentar terus nganti pungkasan baris. Sintaksis:
//here is a single line comment.
Ayo njupuk conto jinis komentar Jawa iki:
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
   }
}
Output yaiku:
Teks iki katon kanggo compiler Java
Biasane komentar siji-baris dumunung ing ndhuwur utawa ngisor panggonan komentar ing program, sok-sok ing baris sing padha. Iku penting sing iku visual cetha apa komentar nuduhake.

Multi-line Komentar

Kadhangkala ora cukup siji baris kanggo nulis komentar Jawa. Contone, sampeyan kudu njlèntrèhaké cara kerja utawa rumus rumit sing sampeyan tindakake. Ing kasus iki, sampeyan bisa nulis sawetara komentar siji-baris, nanging bakal luwih rasional nulis komentar multi-baris. Dheweke ditandhani ing sisih loro kanthi simbol /* */ . Sintaks komentar multi-baris:
/*This comment
is
Multi line comment
we can describe here
what we need */
Ayo duwe conto komentar multi-baris ing 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 Jawa

Iki minangka jinis komentar Jawa khusus sing digunakake kanggo ngasilake kaca dokumentasi. Biasane pangembang nulis komentar dokumentasi nggunakake Javadoc, generator dokumentasi kanggo ngasilake dokumentasi API ing format HTML saka kode sumber Jawa. Format dokumen sing digunakake Javadoc minangka standar industri kanggo dokumentasi kelas Java lan IDE sing paling populer kayata IntelliJ IDEA lan Eclipse, kanthi otomatis ngasilake Javadoc HTML. Komentar dokumentasi Java duwe sintaks ing ngisor iki:
/**
Some important Javadoc comments here
You don’t know it yet, but Javadoc rulez

@author  Java Developer
*/
Ing ngisor iki contone: iku pecahan saka kelas Java Short . Miturut cara, sampeyan bisa ndeleng kode kelas Java saka IDE (contone ing IntelliJ IDEA saka Windows mung pencet ctrl+LBM utawa ctrl + b (ing Windows) ing sembarang kelas utawa jeneng metode).
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")
Iki kode Java saka metode println () sing kondhang lan ditresnani karo komentar kasebut:
/**
* 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 duwe sawetara tag Javadoc khusus sing ditandhani @ sampeyan bisa ndeleng ing kode ing ndhuwur. Conto tag Javadoc kuwi yaiku @author sing nambahake jeneng pangarang kelas. Tag Javadoc liyane yaiku @since nambahake komentar sing nuduhake yen kelas iki digunakake wiwit versi Jawa sing ditemtokake. Nulis dokumen Javadoc sing apik mbutuhake kawruh lan pengalaman (lan sabar!). Sampeyan bisa nemokake informasi luwih lengkap babagan Javadoc ing dokumentasi resmi Cara Nulis Komentar Doc kanggo Alat Javadoc .

PS sawetara conto komentar lucu saka urip 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;
}
Kanggo nguatake apa sing sampeyan sinau, disaranake sampeyan nonton video pelajaran saka Kursus Jawa
Komentar
  • Popular
  • Anyar
  • lawas
Sampeyan kudu mlebu kanggo ninggalake komentar
Kaca iki durung duwe komentar