Можно ли получить предупреждения от javadoc, если что-то пропущено в комментариях javadoc?

Question

Случайно я могу забыть описать некоторые параметры или исключение (или что-то еще) при документировании методов или классов и т. Д.

Можно ли запустить javadoc таким образом, чтобы он предупреждал меня о пропущенных элементах документации?

(я использую ant-скрипт для генерации документации)

Answer 1

Я не знаю ни одной опции javadoc, которая выдаст предупреждение о недокументированных элементах.

Однако, если вы используете Eclipse, взгляните на настройки в

Окно -> Настройки -> Java -> Компилятор -> Javadoc

Там вы можете указать Eclipse выдавать предупреждения на недокументированные элементы.

Answer 2

Используйте Checkstyle ! Он имеет потрясающую интеграцию с Ant и поддерживает сотни других важных проверок для вашего исходного кода.

Проверка JavadocType - это то, что вам нужно.

Answer 3

Мы использовали Doc Check Doclet для более раннего проекта. Он может быть интегрирован со сборкой и генерирует полезные отчеты, которые сообщают вам, какой код имеет плохую документацию.

ПРИМЕЧАНИЕ. Инструмент является бета-версией и больше не поддерживается Sun.

Answer 4

Да, в Eclipse у вас есть проверка для всего, что вы определили, так что вы можете поместить это пропущенное в «предупреждения», и тогда вы сможете увидеть, где вы делаете ошибки.