Комментарий состоит из двух частей: описание и блок тегов. Первый блок содержит всю информацию в свободной форме. Во втором находятся теги (ранее уже упоминали их). Каждый тег начинается с новой строки, через пробел за ним следует значение.
Один тег можно использовать в блоке описания –
@link. Он не обязан быть на новой строке, обрамляется фигурными скобками, и при рендеринге превращается в <a> со ссылкой на другую страницу документации.Среди всех тегов обязательными считаются только
@param для каждого параметра метода, и @return для не-void методов. Они применимы только для методов. А теги @author и @version наоборот, используются только в документации классов. Остальные блочные теги можно использовать везде: •
@deprecated•
@exception (то же что @throws)•
@see•
@since•
@serial (то же что @serialField или @serialData)Теги
@author, @param, @throws и @see могут входить в один комментарий в нескольких экземплярах.#Инструменты