Во всех разобранных ранее примерах структура была простейшая. Но на практике к сожалению не приходится сталкиваться с такими простыми задачами. Поэтому у программистов принято добавлять в коды комментарии. Это полезно как для себя, помогает не забыть, за что отвечает и какие действия выполняет ранее написанный код, так и для других программистов, которые читают Вами написанный "опус".
Итак, комментарии добавляются следующим образом:
1. С помощью символов // Всё, что будет находиться в строке после этих символов, будет проигнорировано компилятором.
2. С помощью символов /* */ Всё, что находится внутри, будет также проигнорировано компилятором. Причём в данном случае можно применять многострочные комментарии. Даже если символы /* и */ будут находиться на разных строках, всё, что находится внутри, будет всё равно проигнорировано компилятором.
Примеры применения комментариев.
int a; //Объявляем целочисленную переменную a
a= 1; //Присваиваем переменной a начальное значение 1
или
/* Объявляем целочисленную переменную a */
int a;
/* Присваиваем ей начальное значение 1 */
a = 1;
или
/* Объявляем целочисленную переменную a
и присваиваем ей начальное значение 1 */
int a = 1;
А теперь предлагаю взять пример из урока 4, демонстрирующий работу с константами, и добавить в него комментарии. Напоминаю, что исходный код был такой:
Теперь предлагаю добавить в код данной программы комментарии. При этом сохраняем программу под новым именем Comment.java
Далее компилируем командой javac Comment.java и запускаем командой java Comment. Результат выполнения программы наблюдаем на экране
Как видим, результат выполнения программы не поменялся.
Теперь рассмотрим ещё один вариант применения комментариев. Иногда программисты применяют такую "фишку": если нужно, чтобы часть написанного кода не исполнялось в данный момент по каким-либо причинам, его можно "закомментить", т.е. поместить необходимую часть кода между символами /* */. Код, находящийся между этими символами, исполняться не будет.
Давайте ещё раз откроем файл Const.java из 4-го урока
И "закомментим" в нём вторую часть следующим образом
Далее изменим имя класса на Comment2 и сохраним файл под новым именем Comment2.java
Затем скомпилируем и запустим программу
Мы видим, что код, помещённый между символами /* и */ не выполнился, т.к. компилятор его проигнорировал. Выполнилась только первая часть программы, которая отвечает за вывод на экран значений констант.
Выводы:
- Комментарии нужны как для себя, чтобы в дальнейшем понимать, какие действия выполняет часть кода в сложной программе, так и для других пользователей Вашим кодом, чтобы код легче читался.
- Однострочные комментарии добавляются с помощью символов //. Весь текст или код, который будет указан в строке после данных символов, будет полностью проигнорирован компилятором. При этом код, который находится до этих символов, будет исполнен.
- Многострочные комментарии добавляются с помощью символов /* */. Весь код, который помещен как на одной строке, так и на нескольких между этими символами, будет проигнорирован компилятором.
- Если нам в текущий момент времени необходимо, чтобы часть кода не исполнялась, при этом код в дальнейшем потребуется, можно его "закомментить" - поместить между символами /* и */
Ссылка на предыдущий урок
Ссылка на содержание курса