The Java коментарі - це оператори в програмі, які не виконуються компілятором та інтерпретатором.
Чому ми використовуємо коментарі в коді?
- Коментарі використовуються, щоб зробити програму більш читабельною, додаючи деталі коду.
- Це дозволяє легко підтримувати код і легко знаходити помилки.
- Коментарі можуть бути використані для надання інформації або пояснення щодо змінна , метод, клас або будь-яка заява.
- Його також можна використовувати для запобігання виконанню програмного коду під час тестування альтернативного коду.
Типи коментарів Java
У Java є три типи коментарів.
- Однорядковий коментар
- Багаторядковий коментар
- Коментар до документації
1) Однорядковий коментар Java
Однорядковий коментар використовується для коментування лише одного рядка коду. Це найпоширеніший і найпростіший спосіб коментування тверджень.
Однорядкові коментарі починаються з двох похилих риск (//) . Будь-який текст перед // не виконується Java.
Синтаксис:
//This is single line comment
Давайте використаємо однорядковий коментар у програмі Java.
CommentExample1.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.
CommentExample2.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} | щоб відобразити відносний шлях до кореневого каталогу згенерованого документа з будь-якої сторінки. |
| @автор | @ім'я автора - текст | Щоб додати автора класу. |
| @код | {@code text} | Щоб показати текст у шрифті коду, не інтерпретуючи його як розмітку html або вкладений тег javadoc. |
| @version | @version текст версії | Щоб указати підзаголовок «Версія» та текст версії, якщо використовується параметр -version. |
| @з | @від випуску | Щоб додати заголовок «З тих пір» із текстом з тих пір до створеної документації. |
| @param | Опис імені параметра @param | Щоб додати параметр із заданою назвою та описом до розділу «Параметри». |
| @return | Опис @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('Addition of numbers: ' + result); } } </p> Скомпілюйте його інструментом javac:
Створити документ
Створення API документації за допомогою javadoc інструмент:
Тепер файли 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('Java comment is executed!!'); } } Вихід:
Наведений вище код генерує вихідні дані, оскільки компілятор аналізує символ Unicode u000d як новий рядок перед лексичним перетворенням, і таким чином код перетворюється, як показано нижче:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Таким чином, символ Юнікоду зміщує оператор друку на наступний рядок, і він виконується як звичайний код Java.