如何在Eclipse中生成Javadoc注释？

Question

213

在Eclipse中有没有一种方法可以生成Javadoc注释？如果有，它是什么？

- antony.trupe

我尝试了另一种答案（两年前），但不喜欢它，所以可以视为重复或不是。 - antony.trupe

无论是重复还是不重复，当你在谷歌搜索“eclipse generate javadoc”时，这都是最顶部的结果。 - Holloway

5个回答

87

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

- coobird

23

在Mac上，按下⌘-alt-J键。 - SteveEdson

2

你让我的生活变得更美好了！每次我使用 shift-alt-J 的时候，我都会感谢你——每次我向同事展示它时，我也会显得非常聪明！ - Redboots

39

这是一个基于Eclipse的插件，可以自动为您的源代码添加Javadoc和文件头。它可以使用Velocity 模板来生成Javadoc注释和文件头中元素名称的初始注释...

- antony.trupe

1

比内置的Alt-Shift-J更好 - trusktr

快捷键是 Ctrl + Alt + J。 - KrishPrabakar

27

您是指菜单项目 -> 生成Javadoc吗？

- Mirek Pluta

该菜单项不在我使用的任何视图中。 - antony.trupe

它在我的Eclipse上，我安装的唯一额外组件是Google Web Toolkit和FindBugs。（这是Ganymede，不是Europa。也许你需要升级？） - Paul Tomblin

2

也许你需要安装Java开发人员专用的Eclipse或J2EE开发人员专用的Eclipse。 - Jherico

如果您前往“首选项->Java->代码模板”并单击“恢复默认值”，会发生什么？因为我有包含所有javadoc内容的注释代码模板。 - Paul Tomblin

2

无论如何，这不是OP正在寻找的。问题（有点误导人）并不是关于生成javadoc，而是在代码中添加javadoc“注释”。 - Pascal Thivent

显示剩余2条评论

23

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

- bmargulies

- antony.trupe

我很感兴趣了解你的观点。 - mohdajami

1

生成Javadoc不会生成Javadoc注释。它会解析Javadoc注释并生成项目文档（通常是HTML）。 - ebelisle

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Stephen C · Accepted Answer

对我来说，最好的方法是使用/**<NEWLINE>或按下Shift-Alt-J（Mac上为⌘-⌥-J）。

我不喜欢在源代码中看到自动生成且未更新实际内容的Javadoc注释。就我而言，这样的Javadoc只是浪费了屏幕空间。

依我之见，最好逐个生成Javadoc注释框架，然后再填写详细信息。