CKTIS / Java
Коментари и документация в Java
Коментари и документация в Java: Java разпознава редови коментари //, блокови /* ... */ и документационни /** ... */; javadoc тълкува тагове и генерира API документация.
Версия: Java SE 21 (JLS and Java SE API); examples verified on the repository Java runtime
Синтаксис
commentsJava разпознава редови коментари //, блокови /* ... / и документационни /* ... */; javadoc тълкува тагове и генерира API документация.
Използвай Javadoc за договора на публично API с @param, @return и @throws, а {@code ...} за безопасно показване на идентификатори и код.
Блоковите коментари не се влагат, затова коментиран код с */ затваря коментара рано; остарял коментар е по-лош от точно име.
Unicode escapes се обработват преди токенизация: \u000a вътре в // може да стане край на ред и следващият текст да се компилира като код.
Коментарите // и /* ... */ не променят изпълнението на int value = 7; единственият ред stdout 7 потвърждава, че се третират като коментари.
Примери
public class Main {
public static void main(String[] args) {
int value = 7; // this comment does not change the expression
/* A block comment can span lines. */
System.out.println(value);
}
}
Резултат
7
Коментарите // и /* ... */ не променят изпълнението на int value = 7; единственият ред stdout 7 потвърждава, че се третират като коментари.