如何在Eclipse中生成Javadoc注释?

ant*_*upe 195 java eclipse javadoc

可能重复:
Javadoc模板生成器

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

Ste*_*n C 341

对我来说,/**<NEWLINE>Shift- Alt- J(或- Alt- J在Mac上)方法效果最好.

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

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

  • @Pascal - 我宁愿删除它/它们,或者首先不生成它们.IMO,生成的javadoc注释增加了零值...除非你把评论到代码比率的虚假提升算作"值". (28认同)
  • 为了节省空间,折叠它! (17认同)
  • 重要提示:如果使用shift-alt-j,请不要忘记将光标放在要记录的方法中,否则您的注释将添加到该文件的顶部. (4认同)

coo*_*ird 78

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

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

public int doAction(int i) {
    return i;
}
Run Code Online (Sandbox Code Playgroud)

Shift-Alt-J方法声明给出:

/**
 * @param i
 * @return
 */
public int doAction(int i) {
    return i;
}
Run Code Online (Sandbox Code Playgroud)

  • 在Mac上,它是`⌘-alt-J` (23认同)
  • 你让我的生活SOOOOO好多了!我每次使用shift-alt-J时都会感谢你 - 每当我向同事展示时我都会看起来很棒! (2认同)

ant*_*upe 37

JAutoDoc:

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


Mir*_*uta 26

你的意思是菜单Project - > Generate Javadoc?

  • 也许您需要安装Eclipse for Java Developers或Eclipse for J2EE开发人员. (2认同)
  • 无论如何,这不是OP所期待的.问题(这有点误导)不是关于生成javadoc而是在代码中添加javadoc"comments". (2认同)

bma*_*ies 14

在您想要javadoc的地方,输入/**<NEWLINE>,它将创建模板.