Иллюстрированный самоучитель по Java
Комментарии
В текст программы можно вставить
комментарии, которые компилятор не будет учитывать. Они очень полезны для пояснений
по ходу программы. В период отладки можно выключать из действий один или несколько
операторов, пометив их символами комментария, как говорят программисты, "закомментарив"
их. Комментарии вводятся таким образом:
-
за двумя наклонными чертами подряд
//, без пробела между ними, начинается комментарий, продолжающийся до конца
строки;
-
за наклонной чертой и звездочкой
/* начинается комментарий, который может занимать несколько строк, до звездочки
и наклонной черты */ (без пробелов между этими знаками).
Комментарии очень удобны для чтения
и понимания кода, они превращают программу в документ, описывающий ее действия.
Программу с хорошими комментариями называют
самодокументированной.
Поэтому
в Java введены комментарии третьего типа, а в состав JDK — программа
javadoc
,
извлекающая эти комментарии в отдельные файлы формата HTML и создающая гиперссылки
между ними: за наклонной чертой и двумя звездочками подряд, без пробелов, /**
начинается комментарий, который может занимать несколько строк до звездочки
(одной) и наклонной черты */ и обрабатываться программой
javadoc
.
В такой комментарий можно вставить указания программе
javadoc
,
которые начинаются с символа @.
Именно так создается документация
к JDK.
Добавим комментарии к нашему примеру
(листинг 1.2).
Листинг 1.2.
Первая программа с комментариями
/**
* Разъяснение
содержания и особенностей программы...
* @author Имя
Фамилия (автора)
* @version 1.0
(это версия программы)
*/
class HelloWorld{
// HelloWorld — это только имя
// Следующий метод
начинает выполнение программы
public static
void main(String[] args){ // args не используются
/* Следующий метод
просто выводит свой аргумент
* на экран дисплея
*/
System.out.println("Hello,
21st Century World!");
// Следующий
вызов закомментирован,
// метод не будет
выполняться
// System.out.println("Farewell,
20th Century!");
}
}
Звездочки в начале строк не имеют
никакого значения, они написаны просто для выделения комментария. Пример, конечно,
перегружен пояснениями (это плохой стиль), здесь просто показаны разные формы
комментариев.
