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

Question

在记录方法或类等时，我可能忘记描述一些参数或抛出异常（或其他内容）。

是否可以以这样的方式运行javadoc，以便警告我缺少文档项？

（我使用ant脚本生成文档）

Answer 1

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

但是，如果您碰巧使用Eclipse，请查看

中的设置

窗口 - ＆gt;偏好 - ＆gt; Java - ＆gt;编译器 - ＆gt;的Javadoc

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

Answer 2

我们使用Doc Check Doclet作为早期项目。它可以与构建集成，并生成有用的报告，告诉您哪些代码的文档很差。

注意：该工具是测试版，不再受Sun支持。

Answer 3

使用Checkstyle！它具有非常棒的Ant集成，并且还支持对源代码进行100次其他重要检查。

JavadocType checker就是你需要的。

Answer 4

是的，在Eclipse中，你已经检查了你所定义的所有内容，因此可以将这个缺失放入“警告”中，而不是你能够看到你犯错的地方。