Intellij 为方法和类生成 javadoc答案

【问题标题】：Intellij generate javadoc for methods and classesIntellij 为方法和类生成 javadoc
【发布时间】：2010-12-23 00:27:55
【问题描述】：

是否可以设置 Intellij 使用 @author 和 @since date 自动为方法和类生成 javadoc？
我在 Eclipse 中有这个功能。
我知道，这些文件有模板，我也可以手动半自动地将 javadoc 添加到选定的方法/类。但我希望生成对于每个生成的方法/类/枚举/接口/字段等都是自动的。
这对例如有用“提取方法”、“覆盖/实现”、“创建 getter/setter”等
这将节省数百个手动操作。
我正在使用 IntelliJ Idea 9.0 BETA 社区版，#IC-90.96。
TIA。

【问题讨论】：

标签： java intellij-idea javadoc auto-generate

【解决方案1】：

目前不可能。你可能想投票给IDEABKL-1787。

【讨论】：

谢谢。这是 JetBrains 的一个奇怪的承诺。我将在星期五投票。但票证不涉及自动为生成的内容添加 javadoc。也许有这个和那个的插件？
IDEA 不会自动生成 JavaDoc 存根，只有在您键入 /** 并按 Enter 时才会生成。有一个旧的 IDEA 文档插件与最新的 IDEA 版本不兼容：plugins.intellij.net/plugin/?id=952。也许有人会重写它。

【解决方案2】：

有 JavaDoc 同步插件 8。http://plugins.intellij.net/plugin/?idea&id=3403 为类中的所有方法生成 javadoc。适用于创意 10。

【讨论】：

我已经安装了这个插件，但是找不到为类中的所有方法生成 cmets 的方法。你能告诉我怎么做吗？
插件的版本 #10 现已存在。帮助说要打开 JavaDoc Sync 插件，转到 Settings->Errors 并选择“JavaDoc issues”。但是设置下没有错误:-(卸载并使用@chance解决方案
#10 版本似乎在plugins.jetbrains.com/plugin/6340-javadoc-sync-plugin-10

【解决方案3】：

要在 intellij Idea 中生成 javadoc，请转到工具->生成 JavaDoc（第 4 个选项）单击它并给出保存文档的路径

【讨论】：

用户没有询问如何自己生成文档。他们想知道如何在 java 代码中创建 cmets。
不过很有帮助！

【解决方案4】：

对于 IntelliJ 12：

在方法名称上方放置插入符号，输入 /** 并按 Enter 让 IntelliJ IDEA 自动为此方法生成 JavaDoc 存根。 See here

【讨论】：

注意：IntelliJ 15 相同
新增：“修复文档注释”操作以修复 Javadoc，以防它已经存在。
这应该是公认的答案，而不是 2009 年的答案，技术不断发展。
就生成文本块而言，Roland 的注释与 Eclipse 提供的最接近。将光标放在要为其生成 javadoc 的代码上，然后 Help > Find Action... 然后开始输入“Fix doc comment”。选择后，按 Enter 执行操作并生成文本。您还可以进入键绑定菜单，搜索相同的操作，并为其分配键绑定。（我认为插入的文本是基于实时模板的，但我不经常这样做以说明或关心。）

【解决方案5】：

对于较新版本的 IntelliJ（2018+），您可以使用此解决方案：

键入/** + 然后在方法签名上方按Enter 将为您创建Javadoc 存根。

【讨论】：

当然，为每个属性、方法、...手动调用_create Javadoc stubs_命令是非常烦人的

【解决方案6】：

我已经放弃希望 IntelliJ 能够做到这一点。我现在在 Eclipse 中打开我的项目，转到所需的文件并调用 JAutoDoc。

【讨论】：

【解决方案7】：

一个简单的选择是访问 Find Action 菜单（Mac：Cmd+Shift+A | Win : Ctrl+Shift+A) 并键入 Generate JavaDoc 操作的任何部分。一旦找到并单击它，就会打开一个用于生成 JavaDocs 的选项菜单，其中包含各种选项和范围。

参考 -> https://www.jetbrains.com/help/idea/mastering-keyboard-shortcuts.html

【讨论】：

【解决方案8】：

其实现在可以了，你可以直接进入“设置/编辑器/文件和代码模板”。在那里，您可以编辑用于创建类、枚举、接口等的模板。我的 Intellij 版本是 2019.2.3，在 linux 上。

【讨论】：

【解决方案9】：

现在有一个可用的新插件。效果很好，您可以使用 alt+insert 生成 javadoc。

它被称为“javaDoc”，它可以直接在插件部分中找到。文档在这里：https://github.com/setial/intellij-javadocs/wiki

【讨论】：

谢谢。我刚刚在我的 Mac 上使用它，它直接集成到生成菜单中。