代码之家  ›  专栏  ›  技术社区  ›  Finbarr

有没有办法在Eclipse中自动生成所有javadoc注释?

  •  41
  • Finbarr  · 技术社区  · 14 年前

    我知道您可以按shift+alt+j为当前代码块插入一个适当的注释模板,但是有没有任何方法可以让Eclipse疯狂地执行这样一个完整的项目呢?

    3 回复  |  直到 5 年前
        1
  •  62
  •   VonC    11 年前

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

    • 转到包资源管理器视图
    • 展开要在其上生成注释的类(打开每个方法)
    • 从包资源管理器树中选择类中所有打开的元素
    • 中高音 + 转移 + J 和voil:对类和每个方法生成的注释

    这对所有项目都不实用的唯一原因是:

    • 你需要打开每一个你想要生成评论的类
    • 一旦对第一组方法进行了注释,如果编写了新方法,您仍然需要重复该过程。

    也就是说,本文描述了另一种方法。” The Problem of Incomplete Javadocs “从2010年3月30日开始,主张 extended Javadoc view .

    扩展的JavaDoc视图本质上是单个代码元素(如类、方法、字段或参数)的不同信息源的聚合器。它被设计为替换现有的EclipseJavaDoc。

    alt text

    有趣的部分与视图中的其他选项卡一起提供: 子类化指令和子类化模式 .
    这些选项卡包含开发人员通常如何扩展所选代码元素的挖掘信息。

    • 子类化选项卡:

    子类化指令是示例代码中常见观察结果的概括,如“向导的子类总是重写其方法” addPages() “或” Reimplementors 属于 Dialog.createContents() 可以称之为超级实现”。

    http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard.png

    http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard-addPages.png

    • 子类化模式选项卡

    子类化模式试图将观察到的基类扩展分组为典型的扩展模式,也就是说,它们通过相似性来集群子类,以在数据中找到模式。

    http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-patterns-ViewerComparator.png

        2
  •  20
  •   Mateen Ulhaq    12 年前

    我还在为Eclipse寻找一个自动JavaDoc工具,发现了一个叫做 JAutodoc .

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

    你可以去看看 here 有关下载和与Eclipse集成的详细说明。

        3
  •  6
  •   StormFoo    14 年前

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