Новая аннотация javadoc @apiNote
Я нашел новый и недокументированный тег javadoc в LongStream документация класса. Тег javadoc @apiNote, похоже, используется для подробного объяснения метода, но нет документации или заметок о выпуске этого тега.
какова настоящая цель? Где его документация?
скомпилированный пример javadoc с использованием @apiNote можно найти в уменьшить метод документации
1 ответов
из пункта списка рассылки, цитируемого @bargenson:
эти теги включены с помощью функции-tag в командной строке инструмента javadoc. Они не предлагаются в качестве стандартных тегов javadoc и могут быть реализованы по-разному в будущих выпусках Java. Поскольку они реализованы как пользовательские теги, просто в документации JDK API, вы не можете автоматически использовать их в своем коде. (Вы можете, конечно, добавить те же параметры командной строки к вызовам javadoc, если вы как эти теги).
таким образом, они не являются стандартными тегами Javadoc вообще.