我工作的代码库......很混乱。这种混乱的一方面是我们有大量方法,其签名不再与关联的 Javadoc 匹配。例如:
/**
*
* @ param foo
*/
public void doFoo(int bar) {...
我不喜欢生成的 Javadoc(因为它几乎总是毫无价值),但我确实可以使用一个工具来遍历我们的代码,查找类似的情况,并且:
- 删除“foo”参数的 javadoc
- 为“bar”参数添加 javadoc(但只是一个空白参数,没有自动生成的文档或任何内容)
存在这样的工具吗?如果没有,是否存在一个恰好#1 的工具?即使这么多也会显着减少我们在构建中收到的垃圾警告的数量。谢谢。
NetBeans 有一个用于此目的的工具。它完全按照你的要求做。
您可以单击Tools
菜单,然后Analyze Javadocs
从一开始,
或右键单击文件并单击Tools
, then Analyze Javadocs
.
然后,这将为您提供在 Javadoc 中发现的所有问题的列表,并提供修复该问题的选项。它允许您修复方法中的单个问题,修复方法、文件、包或整个项目的 javadoc。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)