如何在Eclipse中生成Javadoc注释?

时间:2009-11-21 23:44:15

标签: java eclipse javadoc

  

可能重复:
  Javadoc template generator

有没有办法在Eclipse中生成Javadoc注释?如果是这样,它是什么?

5 个答案:

答案 0 :(得分:341)

对我而言/**<NEWLINE> Shift - Alt - J (或 - < kbd>⌥ - Mac上的 J 方法效果最佳。

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

IMO,当您要填写详细信息时,逐个生成Javadoc注释框架会好得多。

答案 1 :(得分:78)

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;
}

答案 2 :(得分:36)

JAutoDoc

  

一个Eclipse插件,用于自动将Javadoc和文件头添加到源代码中。它可以选择使用Velocity templates为Javadoc和文件头生成元素名称的初始注释...

答案 3 :(得分:25)

你的意思是菜单Project - &gt;生成Javadoc?

答案 4 :(得分:14)

在您想要javadoc的地方,输入/**&lt; NEWLINE&gt;它将创建模板。