在Eclipse中自动生成所有Javadoc注释的任何方法？

Question

我知道你可以按shift + alt + j为当前代码块插入一个合适的注释模板,但有没有办法让eclipse变得疯狂并做一个像这样的整个项目？

Answer 1

对于整个项目,可能不是,但你至少可以:

• 转到Package Explorer视图
• 展开要生成注释的类(打开每个方法)
• 从该Package Explorer树中选择类中所有已打开的元素
• alt+ shift+ J和voilà:在类和每个方法上生成的注释

对所有项目不切实际的唯一原因是:

• 您需要打开要生成注释的每个类
• 一旦第一组方法被评论,如果您编写了新方法,仍需要重复该过程.

话虽如此,2010年3月30日的文章" 不完整的Javadocs问题 "中描述了另一种方法,主张扩展Javadoc视图.

扩展的Javadoc View本质上是单个代码元素(如类,方法,字段或参数)的不同信息源的聚合器.它被设计为现有Eclipse Javadoc的替代品.

有趣的部分是视图中的其他选项卡:Subclassing Directives和Subclassing Patterns.
这些选项卡包含有关开发人员通常如何扩展所选代码元素的挖掘信息.

• 子类选项卡:

子类指令是像示例代码中经常提出的意见概括"精灵的子类总是覆盖的方法addPages()"或" Reimplementors中Dialog.createContents()可以调用它的超强执行".

• 子类化模式选项卡

子类化模式尝试将观察到的基类扩展分组为典型的扩展模式,即,它们通过相似性对子类进行聚类以查找数据中的模式.

Answer 2

我也在寻找一个用于eclipse的自动javadoc工具,并找到了一个名为JAutodoc的工具.

此工具可以很好地生成注释,并且在某些地方只需手动进行微小更改(如果需要).在我看来,这个工具可以节省大约75%的写评论时间.

您可以访问此处获取有关下载和集成eclipse的详细说明.

Answer 3

还有这个插件,我还没试过,但看起来很有希望:JAutoDoc