是否有任何工具自动更新Javadoc？

我工作的代码基础是...凌乱。这种混乱的一个方面是我们有很多方法的签名不再与相关的Javadoc相匹配。例如：是否有任何工具自动更新Javadoc？

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

我不是生成的Javadoc的风扇（因为它几乎总是不值钱的），但我真的可以使用一个工具，通过我们的代码，发现这样的情况下，和：

删除的Javadoc的“富”参数
为“栏”参数（而只是一个空白的，没有自动生成文档或任何东西）

请问这样的工具存在添加的Javadoc？如果不是，那么只有＃1存在的工具？即使这么多，也会大大减少我们在构建中获得的垃圾警告的数量。谢谢。

来源

2009-12-07 machineghost

P.S.我曾尝试在SO中搜索这样的问题（因为我预计会有一个问题），但涉过几百个问题后，我仍然没有提出任何问题，所以...新问题:-) – machineghost 2009-12-07 19:42:08

NetBeans为此提供了一个工具。它完全符合你的要求。

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

然后这给你一个列表，它找到你的Javadocs的所有问题，并带有修复它的选项。它允许您修复方法中的单个问题，修复方法的javadoc，文件，包或整个项目的javadoc。

来源

2009-12-07 19:59:49

默认情况下（至少在** Netbeans 8.0.2 **中）这个工具**不会在私有方法中发现JavaDoc中的错误为了改变**的范围分析Javadoc **进入'工具 - >选项 - >编辑 - >提示 - > JavaDoc - >错误Javadoc - >范围'并将范围更改为私有。 – 2014-12-09 17:28:02

如果您使用的是eclipse，一个解决方案是去Window -> Preferences -> Java -> Compiler -> Javadoc ，然后将'Malformed Javadoc comments'变量设置为警告或错误。

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

来源

2009-12-07 19:52:53

我试过（尽管我将NetBeans解决方案标记为答案，因为它看起来更强大，我个人是Eclipse用户）。但是，没有一个警告出现在问题中:-(当我查看其中一个时，它下面有一条黄色的波浪线，但即使我告诉Eclipse验证该文件，在问题窗口中仍然没有任何提示。关于我可能会做错什么的想法？ – machineghost 2009-12-09 21:01:04

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

来源

2009-12-07 20:07:55 shoover

是否有任何工具自动更新Javadoc？

回答

相关问题