如何在 Eclipse 中生成 Javadoc 注释？ [复制]

Posted 2023-02-26

【中文标题】如何在 Eclipse 中生成 Javadoc 注释？ [复制]

【英文标题】：How can I generate Javadoc comments in Eclipse? [duplicate]

【发布时间】：2010-12-19 03:06:40

【问题描述】：

有没有办法在 Eclipse 中生成 Javadoc cmets？如果有，是什么？

【问题讨论】：

我尝试了替代答案（2 年前）并且不喜欢它，所以不管它是否是重复的。

是否重复，这是谷歌搜索“eclipse generate javadoc”时的最高结果

【参考方案1】：

对我来说 /**<NEWLINE> 或 Shift-Alt-J （或 ⌘- ⌥-J 在 Mac 上）方法效果最好。

我不喜欢看到源代码中的 Javadoc cmets 是自动生成的，并且没有使用真实内容进行更新。在我看来，这样的 javadocs 无非是浪费屏幕空间。

IMO，当您要填写详细信息时，最好一一生成 Javadoc 注释框架。

【讨论】：

为了节省空间，折叠起来！

@Pascal - 我宁愿删除它/它们，或者首先不生成它/它们。 IMO，生成的 javadoc cmets 添加零值...除非您将评论与代码比率的虚假提升算作“值”。

重要提示：如果使用 shift-alt-j，请不要忘记将光标放在要记录的方法中，否则您的注释将添加到该类的文件顶部.

【参考方案2】：

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;

【讨论】：

在 Mac 上是⌘-alt-J

你让我的生活变得更好了！每次我使用 shift-alt-J 时，我都会感谢你——每次我把它展示给同事看时，我都会非常感谢你！

【参考方案3】：

JAutoDoc:

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

【讨论】：

比内置的alt-shift-j好

快捷方式是Ctrl + Alt + J

【参考方案4】：

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

【讨论】：

该菜单项不在我使用的任何透视图中。

它在我的 Eclipse 上，我安装的唯一额外的东西是 Google Web Toolkit 和 FindBugs。 （这是木卫三，不是欧罗巴。也许你需要升级？）

我只有 gwt 视角，eclipse v 3.5.1

也许您需要为 Java 开发人员安装 Eclipse 或为 J2EE 开发人员安装 Eclipse。

无论如何，这不是 OP 想要的。问题（有点误导）不是关于生成 javadoc，而是在代码中添加 javadoc“cmets”。

【参考方案5】：

在你想要javadoc的地方，输入/**，它会创建模板。

【讨论】：

1.这行得通，谢谢。 2. 该菜单项不在我使用的任何透视图中。

我很想知道你的观点是什么

生成 Javadoc 不会生成 Javadoc cmets。它解析 Javadoc cmets 并生成项目文档（通常是 html）