JavaRush/Java блог/Архив info.javarush/Комментарии в языке Java
articles
15 уровень

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

Статья из группы Архив info.javarush
участников
Комментарии в языке Java, как и в большинстве других языков программирования, игнорируются при выполнении программы. Таким образом, в программу можно добавлять столько комментариев, сколько потребуется, не опасаясь увеличить ее объем. Комментарии в языке Java - 1В языке Java есть три способа выделения комментариев в тексте. Чаще всего используются две косые черты //, при этом комментарий начинается сразу за символами // и продолжается до конца строки.
System.out.println("Hello, Java world!");
// наш комментарий
Если нужны более длинные комментарии, можно каждую строку начинать символами. Хотя более удобно ограничивать блоки комментариев разделителями /* и */.
/*
 Пример простой программы на Java
*/

public class SampleProgram
{
 public static void main (String [] args)
 {
 System.out.println("Hello, Java world!");
 }
}
Не следует забывать, что комментарии, выделяемые символами /* и */ в языке Java не могут быть вложенными. Это значит, что фрагмент кода нельзя отключить, просто окружив его /* и */, поскольку отключаемый код сам может содержать разделители /* и */. Ссылка на первоисточник: Комментарии в языке Java
Комментарии (9)
  • популярные
  • новые
  • старые
Для того, чтобы оставить комментарий Вы должны авторизоваться
raswet
Уровень 2
22 марта, 22:38
23032024
Тарас Брага
Уровень 1
29 ноября 2020, 05:08
Отключить код окружив его /* */ можно в любом месте. Писать вложенные комментарии ещё "додуматься" нужно.
Dmitriy
Уровень 22
25 декабря 2018, 09:40
В языке Java есть три способа выделения комментариев
Всегда думал, что два вида (если джавадок не считать), тут написано три, и в качестве примера приведено два. Как ответить в тесте на вопрос, где однозначно спрашивается: 2 или 3?
Hehabr
Уровень 13
22 февраля 2016, 15:17
Много раз встречал короткие комментарии в одну строку всего из нескольких слов, которые оформлены однако по 3 типу, вот так:
/**
 *  Комментарий в одну строку
 */


Если комментарий такой короткий то почему его не записали по 1 типу, вот так:
//  Комментарий в одну строку


Зачем так делается, в чём мысл?
Joysi
Уровень 41
22 февраля 2016, 16:10
Это для будущей генерации документации с использование JavaDoc (https://ru.wikipedia.org/wiki/Javadoc)
Смысл в том, что в одном месте (java-файле), например для методов, перед собственно кодом описываешь стандартным образом что функция делает, какие аргументы принимает, какие результаты возвращает.
Далее, например, можно автоматически создать документацию к твоему коду. И IDE может при встрече в чужом коде вызова твоей функции «подсказать» по этой инфе что передать, в каком порядке и т.п.
Это стандарт документирования кода.
а //-комментарии обычно служат для уточнения реализации в коде.
в IDEA зажми ctrl и щелкни на имени метода, он перенесет к ее вызову и описанию
например для клика по println в
System.out.println(«Привет!»);
/**
     * Prints a String and then terminate the line.  This method behaves as
     * though it invokes {@link #print(String)} and then
     * {@link #println()}
     *
     * @param x  The String to be printed.
     */
    public void println(String x) {
        synchronized (this) {
            print(x);
            newLine();
        }
    }

Можно перед своей функцией ввести /** далее нажать Enter и IDEA автоматически создаст шаблон JavaDoc комментария куда вытащит твои аргументы и результат.
IvanDurov
Уровень 25
30 ноября 2015, 22:47
Про третий способ не написал. Скорей всего этот:

 /**
  * <p>Проверяет, допустимый ли ход.</p>
  * <p>Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4);
  * Чтобы записать рокировку, укажите, откуда и куда ходит король.
  * Например, для короткой рокировки чёрных запишите isValidMove(5,8,7,8);</p>
  *
  * @param fromCol Вертикаль, на которой находится фигура (1=a, 8=h)
  * @param fromRow Горизонталь, на которой находится фигура (1...8)
  * @param toCol   Вертикаль клетки, на которую выполняется ход (1=a, 8=h)
  * @param toRow   Горизонталь клетки, на которую выполняется ход (1...8)
  * @return true, если ход допустим, и false, если недопустим
  */
  boolean isValidMove(int fromCol, int fromRow, int toCol, int toRow) {
      . . .
  }
EvIv
Уровень 30
1 декабря 2015, 09:11
Это тот же многострочный комментарий: начинается с /*, заканчивается на */ и без разницы, что там внутри: звездочки ли, черточки или еще что: главное, чтобы не сочетание */, которое раньше времени бы закрыло этот коммент
IvanDurov
Уровень 25
1 декабря 2015, 10:40
Возможно это не третий тип комментария, но это третий способ выделений комментария в тексте. Именно его парсит Javadoс, ну и конечно IDEA. IDEA даже немного следит за соответствием информации в «javadoc»-комментарии. Комментарий созданный вторым способом отслеживаться IDEA не будет.
mrANDERSON
Уровень 26
1 декабря 2015, 18:49
На самом деле многие источники выделают его как третий тип и называют «документирующим». Так, что Вы правы.