如何在Eclipse中生成Javadoc注释?

是否有一种在Eclipse中生成Javadoc注释的方法?如果有,是什么?

519308 次浏览

JAutoDoc:

一个Eclipse插件,用于自动将Javadoc和文件头添加到源代码中。它可以选择使用速度 模板为Javadoc和文件头文件从元素名生成初始注释…

在你想要javadoc的地方,键入/**<NEWLINE>,它将创建模板。

你的意思是菜单项目->生成Javadoc ?

Shift-Alt-J是Eclipse中用于创建Javadoc注释模板的有用键盘快捷键。

调用类、方法或字段声明上的快捷方式将创建一个Javadoc模板:

public int doAction(int i) {
return i;
}

在方法声明上按Shift-Alt-J会得到:

/**
* @param i
* @return
*/
public int doAction(int i) {
return i;
}

对我来说,/**<NEWLINE>转变-Alt-J(或Mac上的--J)方法效果最好。

我不喜欢看到源代码中的Javadoc注释是自动生成的,并且没有使用实际内容进行更新。在我看来,这样的javadoc只不过是在浪费屏幕空间。

在我看来,在您准备填充细节时,逐个生成Javadoc注释骨架会好得多。