java - 当 javadoc-comments 中遗漏了某些内容时，是否可以从 javadoc 获得警告？

Question

在记录方法或类等时，我可能会意外地忘记描述一些参数或异常抛出（或其他东西）。

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

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

Answer 1

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

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

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

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

Answer 2

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

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

Answer 3

使用检查样式！它具有很棒的 Ant 集成，并且还支持对您的源代码进行 100 多项其他重要检查。

JavadocType检查器是您所需要的。

Answer 4

是的，在 Eclipse 中，您可以检查您定义的所有内容，因此可以将这个缺失放入“警告”中，然后您将能够看到您在哪里犯了错误。