Комментарии в языке Java

Статья из группы Random
Комментарии в языке Java — как и в большинстве других языков программирования, символы, которые игнорируются при выполнении программы. Таким образом, в программу можно добавлять столько комментариев, сколько потребуется, не опасаясь увеличить ее объем. Комментарии используются для описания тонкостей работы конкретного блока кода, метода или класса. Также можно использовать их, если хочется оставить сообщения для программистов, которые в будущем будут работать с этим кодом. Ну или же для собственных заметок. Комментарии в языке Java - 1

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

В языке 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 - 2Что еще почитать? Например, этот материал: Комментарии в Java: не всё так просто. Или лекцию из квеста Java Syntax Pro о комментариях.
Комментарии (27)
ЧТОБЫ ПОСМОТРЕТЬ ВСЕ КОММЕНТАРИИ ИЛИ ОСТАВИТЬ КОММЕНТАРИЙ,
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ
Anonymous #3137786 Уровень 2, Москва, Russian Federation
7 августа 2022
Написано что код не может быть отключен вот так, почему ведь символы должны сделать из него комментарий, как так? /* "код" код код */ Было бы очень неплохо если бы это сразу обьяснили в лекции
Алексей Бескоровайный Уровень 17, Киев, Ukraine
12 июня 2022
Спасибо. Я подписался на ваш премиум, чтобы реализовать задуманное для проекта Virtual Staging. Надеюсь, это поможет и можно будет запустить крутой проект с помощью ваших курсов!
Oskar Shell Уровень 2, Владивосток, Russian Federation
9 июня 2022
public int max(int a, int b, int c) { return Math.max(Math.max(a, b), c); Вопрос про скобку после «b»?! Я уже понял, что закрывающих скобок должно быть столько же, сколько открывающий. А две скобки после «с» не может быть? Или у нее другое значение?
SobakaSutulaya Уровень 3, Москва, Russian Federation
30 мая 2022
интересно конечно
Григоре Борта Уровень 6, United Kingdom
18 мая 2022
nice
Hasan Abdurahmonov Уровень 3, Москва, Russian Federation
25 апреля 2022
cool
Artem Babenko Уровень 2, Russian Federation
11 марта 2022
Привет! Поясните, это для того, чтобы писать в комментарии НЕ текст? Для документирования методов, переменных или классов используется особый способ выделения текста. Делается это с помощью /** и */. При этом каждая строка комментируемого текста начинается с *.Если документируется метод, принято описывать его аргументы и возвращаемое значение.
Stas S Уровень 50, Гродно, Беларусь
19 января 2022
Не следует забывать, что комментарии, выделяемые символами /* и */ в языке Java не могут быть вложенными. Это значит, что фрагмент кода нельзя отключить, просто окружив его /* и */, поскольку отключаемый код сам может содержать разделители /* и */. Объясните, пожалуйста, что же это значит )
19 мая 2021
последовательное сравнение- Math.max ( Math.max (a , b) , c )
Anonymous #2455025 Уровень 2, Санкт-Петербург
12 ноября 2020
в п."Документирующий комментарий" строка 10 после b лишняя закрывающая скобка ) или так правильно? Если правильно, то почему?