В JavaDoc предлагают добавить заметки, которые сложно пропустить
В JavaDoc предлагают добавить тег @note. Он позволит выделять важные примечания прямо в документации API. /** * {@note (header=’Caution:’) * Untrusted input must be verified!} */ Стандартный doclet превратит такую запись в отдельный заметный блок. Заголовок можно менять, а через javadoc ‑tag создавать свои варианты вроде @warning. Сейчас для подобных вещей приходится использовать обычный текст, HTML или нестандартные теги. @note даст единый способ отделить