java - 可以为整个 Eclipse 项目自动创建 javadoc 标签吗？

Question

我知道可以使用 '<alt><shift>J' 为单个代码元素（例如类方法）创建标签。

但是有没有办法为整个项目中的每个类自动创建这些标签？甚至只是在包或类级别？

Answer 1

你看过JAutodoc吗？

Answer 2

从来没听说过。

那有什么好处呢？自动生成的 Javadoc 注释比无用更糟糕；我不希望它们把我的代码弄得乱七八糟，即使没有注释，Javadoc 也会提供尽可能多的信息。

Answer 3

自动生成 JavaDoc 是一件很痛苦的事，因为其他人现在永远不会知道该方法应该做什么，而你自己也不知道，当你一年后看这个类时。

请自行评论您的方法或不评论该方法。

我的公司正在使用 checkstyle 来强制雇主添加 javadoc。一些雇主讨厌评论他们的方法，而只是输入毫无意义的评论。他们没有评论总比没用要好。

使用 checkstyle 您可以找到所有未记录的方法，并以良好的格式记录它们。

什么将帮助您记录 init 方法，例如

“必须在任何其他方法之前调用 init 并初始化类 ActionDummy”

最好说出具体做了什么

初始化动作提供者的默认状态。某些状态变量可以在...时被监听器覆盖。