Как закомментировать в java
Комментарии в 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 и выданы в качестве документации к вашему коду.