В JavaDoc предлагают добавить заметки, которые сложно пропустить
В JavaDoc предлагают добавить тег @note. Он позволит выделять важные примечания прямо в документации API. Читать далее
Это короткая выдержка из материала Хабр. Полный текст остаётся у издателя — перейдите по ссылке, чтобы прочитать его там.
Читать в источнике