В Java коментарите са неизпълними изрази, които обясняват кода и подобряват четливостта. Те се игнорират от компилатора и не влияят на изпълнението на програмата.

• Подобрете четливостта и поддръжката на кода.
• Полезно за отстраняване на грешки и документиране на логика.

Java поддържа три основни типа коментари:

1. Едноредови коментари

Едноредовите коментари се използват за коментиране на един ред код.

Синтаксис:   

// Коментари тук (само текстът в този ред се счита за коментар)

// 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. Многоредови коментари

Многоредовите коментари се използват за описание на сложен код или методи, тъй като писането на множество едноредови коментари може да бъде досадно.

/*
Започва коментар
продължава
продължава...
Коментарът приключва
*/

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. Коментари към документацията

Коментарите към документацията се използват за генериране на външна документация с помощта на Javadoc. Те обикновено се използват в професионални проекти за описание на методи и параметри на класове.

Синтаксис:   

/**
* Начало на коментара
* @param описание на име на параметър
* @return описание
*/

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

Свързана статия: Инструмент JavaDoc

вземете текущата дата в java