Java komentāri ir neizpildāmi paziņojumi, kas izskaidro kodu un uzlabo lasāmību. Kompilators tos ignorē un neietekmē programmas izpildi.

• Uzlabojiet koda lasāmību un apkopi.
• Noderīga atkļūdošanai un loģikas dokumentēšanai.

Java atbalsta trīs galvenos komentāru veidus:

1. Komentāri ar vienu rindiņu

Vienas rindiņas komentāri tiek izmantoti, lai komentētu vienu koda rindiņu.

Sintakse:   

// Komentāri šeit (Tikai teksts šajā rindā tiek uzskatīts par komentāru)

// 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. Vairāku rindu komentāri

Vairāku rindiņu komentāri tiek izmantoti, lai aprakstītu sarežģītu kodu vai metodes, jo vairāku vienas rindiņas komentāru rakstīšana var būt nogurdinoša.

/*
Sākas komentēšana
turpinās
turpinās...
Komentārs beidzas
*/

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. Dokumentācijas komentāri

Dokumentācijas komentāri tiek izmantoti, lai ģenerētu ārēju dokumentāciju, izmantojot Javadoc. Tos parasti izmanto profesionālos projektos, lai aprakstītu klašu metodes un parametrus.

Sintakse:   

/**
* Komentāra sākums
* @param parametra nosaukuma apraksts
* @atgriezties apraksts
*/

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

Saistīts raksts: JavaDoc rīks

Android iestatījumu izvēlne