logo

Java коментари

The Java коментарите са изразите в програма, които не се изпълняват от компилатора и интерпретатора.

Защо използваме коментари в код?

  • Коментарите се използват, за да направят програмата по-четима чрез добавяне на подробности за кода.
  • Улеснява поддържането на кода и лесното намиране на грешките.
  • Коментарите могат да се използват за предоставяне на информация или обяснение относно променлива , метод, клас , или каквото и да е изявление.
  • Може да се използва и за предотвратяване на изпълнението на програмен код, докато се тества алтернативният код.

Видове Java коментари

В Java има три вида коментари.

  1. Коментар на един ред
  2. Многоредов коментар
  3. Коментар на документацията
Java видове коментари

1) Едноредов коментар на Java

Едноредовият коментар се използва за коментиране само на един ред от кода. Това е широко използваният и най-лесният начин за коментиране на твърденията.

Коментарите на един ред започват с две наклонени черти (//) . Всеки текст пред // не се изпълнява от Java.

Синтаксис:

 //This is single line comment 

Нека използваме едноредов коментар в Java програма.

КоментарExample1.java

 public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } } 

Изход:

 10 

2) Многоредов коментар на Java

Многоредовият коментар се използва за коментиране на няколко реда код. Може да се използва за обяснение на сложен кодов фрагмент или за коментиране на няколко реда код наведнъж (тъй като там ще бъде трудно да се използват коментари от един ред).

Многоредовите коментари се поставят между /* и */. Всеки текст между /* и */ не се изпълнява от Java.

Синтаксис:

вземете текущата дата в java
 /* This is multi line comment */ 

Нека използваме многоредов коментар в програма на Java.

КоментарExample2.java

 public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } } 

Изход:

 10 

Забележка: Обикновено // се използва за кратки коментари, а /* */ се използва за по-дълги коментари.

3) Коментар на документацията на Java

Коментарите към документацията обикновено се използват за писане на големи програми за проект или софтуерно приложение, тъй като помагат за създаване на API за документация. Тези API са необходими за справка, т.е. кои класове, методи, аргументи и т.н. се използват в кода.

За да създадем API за документация, трябва да използваме инструмент за javadoc . Коментарите в документацията са поставени между /** и */.

Синтаксис:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

javadoc тагове

Някои от често използваните тагове в коментарите към документацията:

Етикет Синтаксис Описание
{@docRoot} {@docRoot} за изобразяване на относителен път към основната директория на генерирания документ от всяка страница.
@автор @author име - текст За да добавите автора на класа.
@код {@code text} За да покажете текста с кодов шрифт, без да го интерпретирате като html маркиране или вложен javadoc таг.
@версия @version версия-текст За да укажете подзаглавие „Версия“ и текст на версията, когато се използва опцията -version.
@от @от освобождаването За да добавите заглавие „Since“ с текст оттогава към генерираната документация.
@param @param описание на името на параметъра За да добавите параметър с дадено име и описание в секцията „Параметри“.
@връщане @return описание Изисква се за всеки метод, който връща нещо (с изключение на void)

Нека използваме етикета Javadoc в програма на Java.

Calculate.java

 import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println(&apos;Addition of numbers: &apos; + result); } } </p>

Компилирайте го с инструмента javac:

Създаване на документ

java коментари

Създайте API за документация от javadoc инструмент:

java коментари

Сега HTML файловете са създадени за Изчисли клас в текущата директория, т.е. abcDemo . Отворете HTML файловете и можем да видим обяснението на класа Calculate, предоставено чрез коментара на документацията.

Изпълними ли са Java коментарите?

Години: Както знаем, Java коментарите не се изпълняват от компилатора или интерпретатора, но преди лексикалната трансформация на кода в компилатора, съдържанието на кода се кодира в ASCII, за да се направи обработката лесна.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println(&apos;Java comment is executed!!&apos;); } } 

Изход:

java коментари

Горният код генерира изхода, тъй като компилаторът анализира символа Unicode u000d като нова линия преди лексикалната трансформация и по този начин кодът се трансформира, както е показано по-долу:

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println(&apos;Java comment is executed!!&apos;); } } 

По този начин символът Unicode премества оператора за печат на следващия ред и той се изпълнява като нормален Java код.