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

Question

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

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

我不是生成Javadoc的粉丝(因为它几乎总是毫无价值),但我真的可以使用一个工具来查看我们的代码,找到这样的案例,并且:

1. 删除"foo"参数的javadoc
2. 为"bar"param添加javadoc(但只是一个空白的,没有自动生成的文档或任何东西)

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

Answer 1

NetBeans 有一个用于此目的的工具。它完全按照你的要求做。

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

然后，这将为您提供在 Javadoc 中发现的所有问题的列表，并提供修复该问题的选项。它允许您修复方法中的单个问题，修复方法、文件、包或整个项目的 javadoc。