2011-01-13 89 views

回答

6

的Javadoc (写.html文件)为你做了点播(工具 - >生成Javadoc),并基本上是自动的,一旦你设置它。生成javadoc 存根(stub),这是Eclipse的jautodoc所做的,是按方法逐个分类地完成的,并且只有你告诉它的地方。

键入/** <enter>上述方法签名将创建的Javadoc存根为您服务。我怀疑你想要为整个文件,包或项目做这件事(如jautodoc)。曾经有这样一个插件:http://plugins.intellij.net/plugin/?id=952但它不会用于10.

我不得不说,这个jautodoc例子,虽然一个整洁的派对技巧,是我见过的最无用的东西一个IDE:它创建一个基于变量名称的描述 - 但只有当变量名称如此描述以至于它不需要评论时才是首要的。

/** 
* The number of questions 
*/ 
private int numberOfQuestions; 

让你向往冲卡。

+5

一些构建系统使用checkstyle,jalopy等。他们最终要求人们添加跛脚javadoc。最好的做法是让你的代码自己说话,但是当你因为你的公司策略而需要它而造成数据膨胀时,就会发生类似jautodoc的功能。 ctrl alt j,你很好提交。 – branchgabriel 2012-02-07 21:38:17