Java: Комментарии
Практически все языки программирования позволяют оставлять в коде комментарии. Они никак не используются кодом и нужны исключительно для людей: чтобы программист оставлял пометки для себя и для других программистов, пояснял, как работает код, отмечал ошибки или напоминал, что нужно доделать.
// Удалить строку ниже после реализации задачи по регистрации
System.out.println(10);Компилятор полностью игнорирует комментарии — на работу программы они не влияют:
// комментарий ──→ [ пропущено компилятором ]
System.out.println("hello"); ──→ [ выполнено → hello ]
// ещё один ──→ [ пропущено компилятором ]Комментарии в Java бывают трех видов:
Однострочные комментарии начинаются с //. После этих двух символов может следовать любой текст, вся строка не будет анализироваться и исполняться.
Комментарий может занимать всю строку:
// For Winterfell!Также комментарий может находиться на строке после какого-нибудь кода:
System.out.println("I am the King"); // => For Lannisters!Многострочные комментарии начинаются с /* и заканчиваются на */. Принято каждую строку начинать с символа *, хотя технически это и необязательно:
/*
* The night is dark and
* full of terrors.
*/
System.out.println("I am the King"); // => I am the KingДокументирующие комментарии начинаются с /** и заканчиваются на */. Уже для них обязательно каждую строку начинать с символа *.
Документирующие комментарии — это подвид многострочных. При этом несут дополнительную функцию — их можно собрать при помощи специальной утилиты javadoc и выдать в качестве документации к вашему коду. Мы поговорим о них позже – когда разберем классы и методы.
Служебные комментарии
В процессе работы вы будете встречаться с таким кодом в нашем редакторе:
// BEGIN
// ENDBEGIN и END здесь — это обычные однострочные комментарии, которые никак не влияют на работу программы. Они показывают, куда писать код задания.
// BEGIN
<здесь ваше решение>
// ENDУвидев BEGIN и END, пишите свой код между ними, остальное оставляйте без изменений.
Задание
Вы пишете программу и понимаете, что одну часть нужно доделать позже. Чтобы не забыть, программисты оставляют себе заметки прямо в коде — TODO-комментарии.
Добавьте в файл такой однострочный комментарий:
// TODO: добавить метод приветствияКогда вернётесь к этому месту позже, комментарий напомнит, что здесь ещё есть незавершённая работа.
Полезное
Java: Комментарии
Практически все языки программирования позволяют оставлять в коде комментарии. Они никак не используются кодом и нужны исключительно для людей: чтобы программист оставлял пометки для себя и для других программистов, пояснял, как работает код, отмечал ошибки или напоминал, что нужно доделать.
// Удалить строку ниже после реализации задачи по регистрации
System.out.println(10);Компилятор полностью игнорирует комментарии — на работу программы они не влияют:
// комментарий ──→ [ пропущено компилятором ]
System.out.println("hello"); ──→ [ выполнено → hello ]
// ещё один ──→ [ пропущено компилятором ]Комментарии в Java бывают трех видов:
Однострочные комментарии начинаются с //. После этих двух символов может следовать любой текст, вся строка не будет анализироваться и исполняться.
Комментарий может занимать всю строку:
// For Winterfell!Также комментарий может находиться на строке после какого-нибудь кода:
System.out.println("I am the King"); // => For Lannisters!Многострочные комментарии начинаются с /* и заканчиваются на */. Принято каждую строку начинать с символа *, хотя технически это и необязательно:
/*
* The night is dark and
* full of terrors.
*/
System.out.println("I am the King"); // => I am the KingДокументирующие комментарии начинаются с /** и заканчиваются на */. Уже для них обязательно каждую строку начинать с символа *.
Документирующие комментарии — это подвид многострочных. При этом несут дополнительную функцию — их можно собрать при помощи специальной утилиты javadoc и выдать в качестве документации к вашему коду. Мы поговорим о них позже – когда разберем классы и методы.
Служебные комментарии
В процессе работы вы будете встречаться с таким кодом в нашем редакторе:
// BEGIN
// ENDBEGIN и END здесь — это обычные однострочные комментарии, которые никак не влияют на работу программы. Они показывают, куда писать код задания.
// BEGIN
<здесь ваше решение>
// ENDУвидев BEGIN и END, пишите свой код между ними, остальное оставляйте без изменений.
Задание
Вы пишете программу и понимаете, что одну часть нужно доделать позже. Чтобы не забыть, программисты оставляют себе заметки прямо в коде — TODO-комментарии.
Добавьте в файл такой однострочный комментарий:
// TODO: добавить метод приветствияКогда вернётесь к этому месту позже, комментарий напомнит, что здесь ещё есть незавершённая работа.
Полезное
Ваше упражнение проверяется по этим тестам
import static org.assertj.core.api.Assertions.assertThat;
import java.nio.file.Files;
import java.nio.file.Path;
class AppTest {
public static void main(final String[] args) throws Exception {
final var code = Files.readString(Path.of("App.java"));
assertThat(code).containsPattern("//\\s*TODO");
}
}Решение учителя откроется через:
20:00
