当javadoc-comments中缺少某些内容时,是否可以从javadoc获取警告？

Question

在记录方法或类等时,我可能忘记描述一些参数或异常抛出(或其他).

有可能以这样的方式运行javadoc,它会警告我缺少文档项吗？

(我使用ant脚本生成文档)

Answer 1

我不知道任何javadoc选项会发出有关未记录的项目的警告.

但是,如果您碰巧使用Eclipse,请查看中的设置

窗口 - >首选项 - > Java - >编译器 - > Javadoc

在那里,您可以告诉Eclipse对未记录的项目发出警告.

Answer 2

使用检查样式！它具有出色的 Ant 集成，并且还支持对源代码进行数百种其他重要检查。

不过，您需要JavadocType检查器。