Java komentarai yra nevykdomi teiginiai, paaiškinantys kodą ir pagerinantys skaitomumą. Kompiliatorius jų nepaiso ir neturi įtakos programos vykdymui.

• Pagerinkite kodo skaitomumą ir priežiūrą.
• Naudinga derinant ir dokumentuojant logiką.

„Java“ palaiko tris pagrindinius komentarų tipus:

1. Vienos eilutės komentarai

Vienos eilutės komentarai naudojami komentuoti vieną kodo eilutę.

Sintaksė:   

// Komentuoti čia (tik šios eilutės tekstas laikomas komentaru)

// Java program to show single line comments class GFG {  public static void main(String args[])  {   // Single line comment here  System.out.println('Single Line Comment Above');   } } 

Single Line Comment Above 

2. Kelių eilučių komentarai

Kelių eilučių komentarai naudojami sudėtingam kodui ar metodams apibūdinti, nes kelių vienos eilutės komentarų rašymas gali būti varginantis.

/*
Prasideda komentaras
tęsiasi
tęsiasi...
Komentaras baigiasi
*/

class GFG {  public static void main(String args[])  {   System.out.println('Multi Line Comments Below');    /* Comment line 1  Comment line 2   Comment line 3  */  } } 

Multi Line Comments Below 

3. Dokumentacijos komentarai

Dokumentacijos komentarai naudojami išorinei dokumentacijai generuoti naudojant Javadoc. Paprastai jie naudojami profesionaliuose projektuose, apibūdinant klasių metodus ir parametrus.

Sintaksė:   

/**
* Komentarų pradžia
* @param parametro pavadinimo aprašymas
* @grįžti aprašymas
*/

/**  *   * Calculates the average of three integers.  * @author Pratik Agarwal  * @version 1.0  * @since 2017-02-18  */ public class FindAvg{  /**  * Finds average of three integers.  * @param numA First parameter  * @param numB Second parameter  * @param numC Third parameter  * @return Average of numA numB and numC  */  public int findAvg(int numA int numB int numC)  {  return (numA + numB + numC) / 3;  }  /**  * Main method which uses findAvg method  * @param args Unused  */  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);  } } 

Average of 10 20 and 30 is: 20 

Susijęs straipsnis: JavaDoc įrankis

java pridėti eilutę