Совет по использованию метода или важное ограничение легко потерять внутри длинного описания. Для JDK 28 предлагают тег
@note, который выделяет такие фрагменты при генерации документации.В заметке OpenJDK Quality Outreach показаны два варианта: встроенная заметка с вертикальной полосой и блочная с отдельным заголовком. Заголовок можно изменить, например на Caution:
/**
* {@note (header='Caution:') Verify untrusted input!}
*/
Атрибуты
kind и id позволяют добавить CSS-класс и идентификатор HTML-элемента. Предложение также предусматривает настройку собственных тегов через параметры javadoc.Пока это предлагаемые изменения для JDK 28. Пример полезен для знакомства с будущим форматом; использовать его как поддерживаемый синтаксис в документации проекта на JDK 27 рано.
#java #документация