2010-03-27 137 views
35

我知道你可以按shift + alt + j为当前的代码块插入一个合适的评论模板,但是有没有什么办法让eclipse变得疯狂并且做一个这样的整个项目?任何方式来在Eclipse中自动生成所有Javadoc注释?

+0

呃,任何有效的理由实际上这样做?我知道那些认为自动生成的文档比没有文档好的人,但他们实际上并没有包含更多的信息.​​.....它只是使得找到需要记录的地方更难...... – Joey 2010-03-27 16:45:39

+11

是的,有一个合理的理由做这个。当我通过我的所有代码编写javadoc时,它将使我无需手动按shift + alt + j数百次。 – Finbarr 2010-03-27 17:20:40

+0

我希望你想知道永远不要使用它) – eckes 2017-04-27 01:37:54

回答

53

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

  • 去Package Explorer视图
  • 展开要生成的注释类(打开每个方法)
  • 然后从包资源管理器树
  • ALT类中的所有打开的元素 + 转变 + Ĵ就万事大吉了:评论在类生成的,并且每一个方法

它不是对所有的项目实践的唯一原因是:

  • 你需要打开你想生成每个班级关于
  • 的评论一旦第一组方法已被评论,如果您已经编写了新的方法,您仍然需要重复该过程。话虽这么说

,另一种方法是文章 “The Problem of Incomplete Javadocs” 从三月30日2010年描述,倡导一种extended Javadoc view

扩展的Javadoc视图基本上是对于像类,方法,字段或参数的单个码元不同的信息源的聚合器。它被设计为替代现有的Eclipse Javadoc。

alt text

有趣的部分配备了该视图中的其他选项卡:子类指令和子类模式
这些选项卡包含有关开发人员通常如何扩展选定代码元素的挖掘信息。

  • 子类选项卡:

子类指令是像在示例代码频繁进行的观察的概括“精灵的子类始终覆盖其方法addPages()”或“的Dialog.createContents()Reimplementors可以调用其超实施”。

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

+0

你能指点一下快捷键Alt + Shift + J的菜单项给我们的Mac用户吗? – 2011-03-04 09:29:58

+0

@Nithesh:在Mac上的Cmd-Shift-J,如http://mobile.tutsplus.com/tutorials/android/javadoc/ – VonC 2011-03-04 09:59:23

+0

中提到的那样:注意自我:与第10次一起出现的“好回答”和“启蒙”徽章投票标记了我的第1000个徽章,即2012年8月24日。 – VonC 2012-08-28 09:10:53

19

我也一直在寻找为Eclipse自动javadoc工具,发现一个叫JAutodoc

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

您可以访问here了解有关下载和eclipse集成的详细说明。

+1

谢谢@阿伦。我在Eclipse中配置了注释,但Alt + Shift + J放置了一个空的javadoc,而不是使用配置的(Preferences> Java> Code Style> Code Templates)。 JAutodoc做了我想要的。我现在有JAutodoc在所需的列表中:) – 2014-04-11 01:04:40

+0

JAuto Doc生成比eclipse更好的注释Alt + Shift + J – Sabyasachi 2017-02-23 13:37:18

相关问题