为Java项目生成Javadoc

Question

最近，我们计划在我们的项目中使用checkstyle插件。 作为此练习的一部分，必须清理现有代码以符合checkstyle规则。 我们发现接近18K的违规对应于类文件中缺少javadoc注释。

我的问题是，是否可以使用任何插件或工具为整个工件生成javadoc注释？ 我看了一下JAutodoc ，我想知道是否有什么比这更好的了。

Answer 1

即使CheckStyle得分上升，生成JavaDoc也会降低您的实际代码质量。 生成的JavaDoc只能反映代码中已经显而易见的内容，它增加了体积，从而降低了可读性，并且（取决于您的工具）可能无法保持最新​​状态，从而增加了维护负担并在代码演变后导致不一致。

不要让自己陷入混乱的代码中。 应该将CheckStyle违规作为提示，而不是绝对的铁定规则。 添加明智的JavaDoc需要花费时间和对代码的理解，您应该制定从现在开始在所有新代码中创建它的策略，并在重构后将其添加到任何现有代码中。

顺便说一句：您不必全部使用JavaDoc。 我个人没有JavDoc的默认getter / setter，覆盖或方法/字段带有不言自明的名称（我努力争取）。 我总是使用JavaDoc的顶级实体（接口，类和枚举），并将非JavaDoc注释放在功能复杂的代码块上。

Answer 2

如果创建NetBeans项目，则可以要求它为您自动生成缺少的框架。 只需在项目上单击鼠标右键，即可选择菜单项，然后所有丢失的骨架都就位。

另一个工具（要花钱，但很值得）是triemax的Jalopy的商业版本，它是出色的代码格式化程序（开发人员超级灵敏，可以在请求时相对快速地添加新功能）。

Answer 3

最近有同样的问题。 我们只是将checkstyle配置文件更改为将缺少的javadocs设置为警告，直到我们的贡献者包括了缺少的文档为止。

如何做到这一点在这里描述为链接文本 ，或者您可以使用提供GUI界面的eclipse checkstyle插件。