В JavaDoc предлагают добавить заметки, которые сложно пропустить

1 мин
В JavaDoc предлагают добавить заметки, которые сложно пропустить

В JavaDoc предлагают добавить тег @note. Он позволит выделять важные примечания прямо в документации api.

/**
 * {@note (header='Caution:')
 * Untrusted input must be verified!}
 */

Стандартный doclet превратит такую запись в отдельный заметный блок. Заголовок можно менять, а через javadoc -tag разрабатывать свои варианты вроде @warning.

Сейчас для подобных вещей приходится использовать обычный текст, HTML или нестандартные теги. @note даст единый метод отделить важное замечание от простыни документации.

Пока это только предложение для JDK 28. Команда OpenJDK собирает обратную связь, поэтому до релиза синтаксис ещё может измениться. 

Все для людей!

Присоединяйтесь к русскоязычному сообществу разработчиков на Spring Boot в телеграм — Spring АйО, чтобы быть в курсе последних новостей из мира разработки на Spring Boot и всего, что с ним связано.

Читают сейчас

Исследователи изучили ещё одну причину коррозии, потенциально способную влиять на деградацию металлов

7 минут назад

Исследователи изучили ещё одну причину коррозии, потенциально способную влиять на деградацию металлов

Если оставить металл под дождём в достаточной степени надолго, даже с защитным покрытием, коррозия в конце концов сделает своё дело. Изначально учёные выдвинули гипотезу, что причиной столь сильной ко

GlowByte приняла участие в конференции Smart Data – 2026 в Китае

1 час назад

GlowByte приняла участие в конференции Smart Data – 2026 в Китае

GlowByte приняла участие в 8-й международной конференции FanRuan Smart Data Conference – 2026, которая прошла 10–12 сентября в Ухане, в отеле InterContinental Wuhan. Лозунг конференции в этом году – «

Mac mini с M6 стабильно эмулирует Pentium II на 600 МГц; итог на 20% выше, чем у Mac mini с M4

2 часа назад

Mac mini с M6 стабильно эмулирует Pentium II на 600 МГц; итог на 20% выше, чем у Mac mini с M4

Разработчик протестировал свежий Mac mini с M6 в эмуляторе ретрокомпьютеров 86Box. Платформа смогла стабильно эмулировать Pentium II Deschutes с частотой 600 МГц под Windows 98 SE со 100% скоростью эм

GitHub Copilot получил локальную изолированную среду для выполнения действий

2 часа назад

GitHub Copilot получил локальную изолированную среду для выполнения действий

GitHub добавил в приложение Copilot локальные изолированные среды (local sandboxes), которые позволяют агенту выполнять действия с кодом внутри ограниченного окружения на компьютере разработчика. Тако

Google тестирует функцию Gemini «Позвони за меня»

3 часа назад

Google тестирует функцию Gemini «Позвони за меня»

Google внедряет в ИИ Gemini новую функцию под названием «Call for Me» (“Позвони за меня”), позволяющую звонить в различные организации. На начальном этапе она станет доступна владельцам смартфонов Pix