- Статус
- Оффлайн
- Регистрация
- 9 Июл 2019
- Сообщения
- 97
- Реакции
- 17
Комментарии
Целью включения комментариев в ваш код являются объяснение, что делает ваша программа.
Java поддерживает и однострочные, и многострочные комментарии. Все символы, которые находятся внутри комментариев, игнорируются Java компилятором.
Однострочный комментарий начинается с двух косых черт (слэшей) и продолжается до окончания строки.
Например:
Многострочные Комментарии
Java также поддерживает комментарии, которые занимают несколько строк. Такой комментарий начинается с символа косой черты, за которым следует символ звездочки, и заканчивается символом звездочки, за которым следует символ косой черты.
Например:
Обратите внимание, что Java не поддерживает вложенные многострочные комментарии.
Однако, вы можете вложить однострочные комментарии внутри многострочных комментариев.
Комментарии Документации
Комментарии Документации это специальные комментарии, которые выглядят как многострочные комментарии,
но отличаются тем, что они генерируют внешнюю документацию вашего исходного кода. Они начинаются с символа косой черты, за которым следуют два символа звездочки, и заканчиваются символом звездочки, за которым следует символ косой черты.
Например:
Javadoc это инструмент, который включен в JDK и используется для генерации документации Java кода в HTML
формате из исходного Java кода, которому необходима документация в предопределенном формате.
Если комментарий документации начинается более чем с двух символов звездочки, то Javadoc предполагает, что
вы хотели создать "блок" вокруг вашего комментария в исходном коде. Дополнительные символы звездочки просто игнорируются.
Например:
Целью включения комментариев в ваш код являются объяснение, что делает ваша программа.
Java поддерживает и однострочные, и многострочные комментарии. Все символы, которые находятся внутри комментариев, игнорируются Java компилятором.
Однострочный комментарий начинается с двух косых черт (слэшей) и продолжается до окончания строки.
Например:
Java:
// Пример однострочного комментария
y = 0; // Пример однострочного комментария после кодаДобавление комментариев при написании кода является хорошей практикой, потому что оно добавляет ясность и понимание при возвращении для его редактирования, также как и для других программистов, желающих посмотреть ваш код.
Многострочные Комментарии
Java также поддерживает комментарии, которые занимают несколько строк. Такой комментарий начинается с символа косой черты, за которым следует символ звездочки, и заканчивается символом звездочки, за которым следует символ косой черты.
Например:
Java:
/* You
Game
.
biz */Однако, вы можете вложить однострочные комментарии внутри многострочных комментариев.
Java:
/* Однострочные комментарий:
// Однострочный комментарий
*/Другим названием многострочного комментария является блочный комментарий.
Комментарии Документации
Комментарии Документации это специальные комментарии, которые выглядят как многострочные комментарии,
но отличаются тем, что они генерируют внешнюю документацию вашего исходного кода. Они начинаются с символа косой черты, за которым следуют два символа звездочки, и заканчиваются символом звездочки, за которым следует символ косой черты.
Например:
Java:
/** Комментарий документации */
/** Комментарий
документации */Javadoc это инструмент, который включен в JDK и используется для генерации документации Java кода в HTML
формате из исходного Java кода, которому необходима документация в предопределенном формате.
Если комментарий документации начинается более чем с двух символов звездочки, то Javadoc предполагает, что
вы хотели создать "блок" вокруг вашего комментария в исходном коде. Дополнительные символы звездочки просто игнорируются.
Например:
Java:
/**********************
YouGame.biz
***********************/Для документации будет сохранен только текст "YouGame.biz"
