User articles
articles
15 уровень

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

Статья из группы Архив info.javarush.ru
Комментарии в языке 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
Что еще почитать:

Группа Random:

Комментарии (8)
ЧТОБЫ ПОСМОТРЕТЬ ВСЕ КОММЕНТАРИИ ИЛИ ОСТАВИТЬ КОММЕНТАРИЙ,
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ
Тарас Брага Уровень 1, Киров, Россия
29 ноября 2020
Отключить код окружив его /* */ можно в любом месте. Писать вложенные комментарии ещё "додуматься" нужно.
Dmitriy Уровень 22, Москва, Россия
25 декабря 2018

В языке Java есть три способа выделения комментариев
Всегда думал, что два вида (если джавадок не считать), тут написано три, и в качестве примера приведено два. Как ответить в тесте на вопрос, где однозначно спрашивается: 2 или 3?
Hehabr Уровень 13, Peine, Германия
22 февраля 2016
Много раз встречал короткие комментарии в одну строку всего из нескольких слов, которые оформлены однако по 3 типу, вот так:
/**
 *  Комментарий в одну строку
 */


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


Зачем так делается, в чём мысл?
IvanDurov Уровень 25, Украина
30 ноября 2015
Про третий способ не написал. Скорей всего этот:

 /**
  * <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) {
      . . .
  }