Комментарии

Комментарии не влияют на результирующий бинарный код и используются только для ввода пояснений к программе.

В Java комментарии бывают двух видов:

· строчные

· блочные

Строчные комментарии начинаются с ASCII -символов // и длятся до конца текущей строки. Как правило, они используются для пояснения именно этой строки, например:

int y=1970; // год рождения

Блочные комментарии располагаются между ASCII -символами /* и */, могут занимать произвольное количество строк, например:

/*

Этот цикл не может начинаться с нуля

из-за особенностей алгоритма

*/

for (int i=1; i<10; i++) {

...

}

Часто блочные комментарии оформляют следующим образом (каждая строка начинается с * ):

/*

* Описание алгоритма работы

* следующего цикла while

*/

while (x > 0) {

...

}

Блочный комментарий не обязательно должен располагаться на нескольких строках, он может даже находиться в середине оператора:

float s = 2*Math.PI/*getRadius()*/;

// Закомментировано для отладки

В этом примере блочный комментарий разбивает арифметические операции. Выражение Math.PI предоставляет значение константы PI, определенное в классе Math. Вызов метода getRadius() теперь закомментирован и не будет произведен, переменная s всегда будет принимать значение 2 PI. Завершает строку строчный комментарий.

Комментарии не могут находиться в символьных и строковых литералах, идентификаторах (эти понятия подробно рассматриваются далее в этой лекции). Следующий пример содержит случаи неправильного применения комментариев:

// В этом примере текст /*…*/ станет просто

// частьюстроки s

String s = "text/*just text*/";

/*

Следующая строка станет причиной ошибки

при компиляции, так как комментарий разбил

имяметода getRadius()

*/

circle.get/*comment*/Radius();

А такой код допустим:

// Комментарий может разделять вызовы функций:

circle./*comment*/getRadius();

// Комментарий может заменять пробелы:

int/*comment*/x=1;

В последней строке между названием типа данных int и названием переменной x обязательно должен быть пробел или, как в данном примере, комментарий.

Комментарии не могут быть вложенными. Символы /*, */, // не имеют никакого особенного значения внутри уже открытых комментариев, как строчных, так и блочных. Таким образом, в примере

/* начало комментария /* // /** завершение: */

описан только один блочный комментарий. А в следующем примере (строки кода пронумерованы для удобства)

1. /*

2. comment

3. /*

4. more comments

5. */

6. finish

7. */

компиляторвыдастошибку. Блочный комментарий начался в строке 1 с комбинации символов /*. Вторая открывающая комбинация /* на строке 3 будет проигнорирована, так как находится уже внутри комментария. Символы */ в строке 5 завершат его, а строка 7 породит ошибку – попытка закрыть комментарий, который не был начат.

Любые комментарии полностью удаляются из программы во время компиляции, поэтому их можно использовать неограниченно, не опасаясь, что это повлияет на бинарный код. Основное их предназначение - сделать программу простой для понимания, в том числе и для других разработчиков, которым придется в ней разбираться по какой-либо причине. Также комментарии зачастую используются для временного исключения частей кода, например:

int x = 2;

int y = 0;

/*

if (x > 0)

y = y + x*2;

else

y = -y - x*4;

*/

y = y*y;// + 2*x;

В этом примере закомментировано выражение if-else и оператор сложения +2*x.