为Eclipse中的现有代码生成JavaDoc注释

时间:2010-05-04 17:05:26

标签: java eclipse comments javadoc

我知道在创建它们时可以在向导屏幕中为类,接口等生成注释,但是我没有找到为现有文件生成javadoc注释的选项。有可能吗?

感谢。

3 个答案:

答案 0 :(得分:17)

命令为“Add Javadoc Comment”或“Generate Element Comment”( Alt + Shift + J ) ,它取决于当前选择的 one 元素。

无法应用于所有文件。因此,如果您通过项目资源管理器视图选择所有类,则无法从那里生成所有缺少的注释。

但是从项目资源管理器中,Vitalii Fedorenko在评论中提及它可行(仅测试它):

  

你应该在Package Explorer中展开一个类,选择所有元素然后按 Alt + Shift + J

http://img683.i_mageshack.us/img683/2263/eclipsegenjavadoc.png

答案 1 :(得分:6)

如果您想将双手放在键盘上,那么在方法前按行/**并按Enter键也是如此:

/**[press enter here]
int avg(int a, int b) throws ArithmeticException {
    ...
}

- >

/**
 * 
 * @param a
 * @param b
 * @return
 * @throws ArithmeticException
 */
int avg(int a, int b) throws ArithmeticException {
    ...
}

答案 2 :(得分:2)

这个https://stackoverflow.com/a/8223484/830945为这个问题提供了一个非常好的解决方案。

我自己已经对它进行了测试,并且它与eclipse的效果非常好。 您只需右键单击项目,然后选择所需选项。可以从http://jautodoc.sourceforge.net/index.html

下载