任何方式来自动生成Eclipse中的所有Javadoc评论?
我知道你可以按shift + alt + j为当前的代码块插入一个合适的注释模板,但是有没有什么办法让eclipse变得疯狂,做这样的整个项目?
对于整个项目,可能不是,但你至less可以:
- 进入Package Explorer视图
- 展开你想要生成评论的类(打开每个方法)
- 从该包资源pipe理器树中select所有打开的元素
- alt + shift + J和voilà:在类上生成的注释,以及每种方法
全部项目不切合实际的唯一原因是:
- 你需要打开你想要生成评论的每个类
- 一旦第一组方法已经被评论,如果你已经写了新的方法,你仍然需要重复这个过程。
也就是说,2010年3月30日的文章“ 不完整的Javadocs问题 ”中描述了另一种方法,主张扩展Javadoc观点 。
扩展的Javadoc视图本质上是一个像一个类,方法,字段或参数一样的单个代码元素的不同信息源的聚合器。 它被devise成替代现有的Eclipse Javadoc。
有趣的部分来自视图中的其他选项卡: 子类化指令和子类化模式 。
这些选项卡包含有关开发人员通常如何扩展所选代码元素的挖掘信息。
- 子类选项卡:
子类化指令是在例如“向导的子类始终覆盖其方法
addPages()
”或“Dialog.createContents()
Reimplementors
可以调用其超级实现”的示例代码中经常进行观察的概括。
- 子类化模式选项卡
子类化模式尝试将观察到的基类的扩展分组为典型的扩展模式,即,通过相似性将子类聚类以在数据中查找模式。
我也在寻找一个eclipse的自动javadoc工具,并find一个名为JAutodoc 。
这个工具生成的评论非常好,只需要在一些地方(如果你需要的话)手动稍做改动。 在我看来,这个工具可以节省大约75%的写评论时间。
您可以在这里访问有关下载和eclipse集成的详细说明。
还有这个插件,我还没有尝试,但看起来很有前途: JAutoDoc