有没有自动更新Javadoc的工具？

Question

我在代码库上工作......凌乱。这种混乱的一个方面是我们有很多方法，其签名不再与相关的Javadoc相匹配。例如：

/**
 *
 * @ param foo
 */
public void doFoo(int bar) {...

我不喜欢生成的Javadoc（因为它几乎总是毫无价值），但我真的可以使用一个工具来查看我们的代码，找到这样的案例，并且：

1. 删除“foo”param
的javadoc
2. 为“bar”param添加javadoc（但只是空白，没有自动生成的文档或任何内容）

这样的工具是否存在？如果没有，那么＃1的工具是否存在？即便这样也会大大减少我们在构建中获得的垃圾警告量。感谢。

Answer 1

如果你正在使用eclipse，一个解决方案就是转到Window -> Preferences -> Java -> Compiler -> Javadoc 然后将'格式错误的Javadoc comments'变量设置为警告或错误。

然后，您可以转到问题视图Window -> Show View -> Problems，然后右键单击每个错误并选择“快速修复”。

Answer 2

NetBeans有一个工具。它完全符合你的要求。

您可以点击Tools菜单，然后点击顶部的Analyze Javadocs， 或者右键单击文件，然后单击Tools，然后点击Analyze Javadocs。

然后，这将为您提供一个列表，列出它在Javadocs中找到的所有问题以及修复它的选项。它允许您修复方法中的单个问题，修复方法的javadoc，文件，包或整个项目。

Answer 3

我没有尝试过除DocCheck以外的任何其他内容，但是this somewhat-dated page on Sun's site列出了几个第三方doclet，其中一些旨在将Javadoc插入到您的源代码中。其中，您可以查看Doc-o-Matic，JRefactory Pretty Printer和ACTOS Auto Commentator for Java。同样，我没有尝试过这些，但它是一个开始的地方。