为java项目生成javadoc

Question

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

我的问题是，是否有任何插件或工具可用于为整个工件生成javadoc注释？ 我看了JAutodoc，我愿意 想知道是否还有比这更好的东西。

Answer 1

即使CheckStyle分数上升，您的实际代码质量也会因生成JavaDoc而下降。生成的JavaDoc只能反映代码中已经很明显的东西，它增加了卷，这降低了可读性，它可能（取决于你的工具）不会使自己保持最新，增加了维护负担并导致代码发展后的不一致。 / p>

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

BTW：你没有JavaDoc的一切。我个人没有JavDoc默认的getter / setter，覆盖或带有自解释名称的方法/字段（我努力争取）。我总是JavaDoc顶级实体（接口，类和枚举），并将非JavaDoc注释放在执行复杂操作的代码块上。

Answer 2

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

另一个工具（花钱，但非常值得）是Jalopy from triemax的商业版本，它是一个优秀的代码格式化程序（开发人员具有超级响应能力，并在需要时相对快速地添加新功能）。

Answer 3

最近有同样的问题。我们刚刚更改了checkstyle配置文件，只将缺少的javadoc设置为警告，直到我们的贡献者包含了丢失的文档。

如何执行此操作在此处link text，或者您可以使用提供GUI界面的eclipse checkstyle插件。