Коментарі в мові Java

Коментарі в мові Java - як і в більшості інших мов програмування, символи, які ігноруються під час виконання програми. Таким чином, до програми можна додавати стільки коментарів, скільки потрібно, не побоюючись збільшити її обсяг. Коментарі використовуються для опису тонкощів конкретного блоку коду, методу або класу. Також можна використовувати їх, якщо хочеться залишити повідомлення для програмістів, які у майбутньому працюватимуть із цим кодом. Ну або ж для своїх нотаток.

Способи виділення коментарів

У мові Java є два способи виділення коментарів у тексті.

Коментар реалізації (коментар коду)

1. Коментування рядка

   Це найчастіше використовуваний тип коментарів. Щоб написати такий коментар, потрібно використовувати дві косі риси //. При цьому коментар починається відразу за символами //та триває до кінця рядка.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. Коментування блоку тексту

   Якщо потрібні більш довгі коментарі, кожен рядок можна починати символами. Хоча зручніше обмежувати блоки коментарів роздільниками /*та */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   Не слід забувати, що коментарі, що виділяються символами /*та */в мові Java, не можуть бути вкладеними. Це означає, що фрагмент коду не можна відключити, просто оточивши його /*і */, оскільки код, що відключається сам може містити роздільники /*і */.

Документуючий коментар

Для документування методів, змінних чи класів використовується особливий спосіб виділення тексту. Робиться це за допомогою /**та */. При цьому кожен рядок коментованого тексту починається з *.Якщо документується метод, прийнято описувати його аргументи та значення, що повертається.

/**
* Метод возвращает максимальное значення
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

Що ще почитати? Наприклад, цей матеріал: Коментарі в Java: не все так просто . Або лекцію з квесту Java Syntax Pro про коментарі.