Коментарі JavaDoc, у яких використовується синтаксис «коса риска-зірочка-зірочка», «зірочка-коса риска» ( /** … */ ), служать іншим цілям, ніж вбудовані коментарі та багаторядкові коментарі Java. Тоді як вбудовані та блокові коментарі Java читаються іншими розробниками, які обслуговують код, Коментарі JavaDoc призначені для розробників, які використовують ваш код.13 липня 2022 р
Java підтримує три основні типи коментарів – Однорядкові коментарі для коротких приміток, багаторядкові коментарі для детальних пояснень або коду вимкнення та коментарі до документації для створення JavaDoc.
В основному є два типи коментарів: Рядковий коментар. Заблокувати коментар.
У класі коментар повинен назвати клас, описати його призначення та назвати автора. У методі коментар має описувати його призначення, коментувати всі аргументи, значення, що повертається, і будь-які винятки за допомогою ключових слів JavaDoc.
Javadoc — це генератор документації, створений Sun Microsystems для мови Java (зараз належить корпорації Oracle) для генерування документації API у форматі HTML із вихідного коду Java. Формат HTML використовується для зручності створення гіперпосилань на пов’язані документи.
Коментарі JavaDoc, у яких використовується синтаксис «коса риска-зірочка-зірочка», «зірочка-коса риска» ( /** … */ ), служать іншим цілям, ніж вбудовані коментарі та багаторядкові коментарі Java. Тоді як вбудовані та блокові коментарі Java читаються іншими розробниками, які обслуговують код, Коментарі JavaDoc призначені для розробників, які використовують ваш код.