Intellij 的 javadoc 自动生成

Question

是否有适用于 IntelliJ 的自动 Javadoc 生成插件？示例http://jautodoc.sourceforge.net/

Answer 1

更新了2020.3 IntelliJ 版本的答案（也适用于2019.2）

1. 下载插件“JavaDoc”（Ctrl + Shift + A > Plugins > Marketplace 标签 > 搜索JavaDoc（供应商：“Sergey Timofiychuk”）> 安装）

并按照以下步骤（从第 2 步开始）。

--上一个答案--

在2018.2 IntelliJ 版本中测试

1. 下载插件“JavaDoc2”（Ctrl + Shift + A > Plugins > Browse Repositories... > JavaDoc2）
2. 重启 IntelliJ (File > Invalid Caches/Restart... > Just Restart)
3. 对于当前元素： 要为当前元素生成 Javadoc（比如 setter 方法），请按 Alt + Shift + G。如果由于不同的键盘映射关联而这不起作用，请尝试 Alt + Insert 并选择 Create JavaDocs for the selected element
4. 全班：要为全班生成，请按Ctrl + Alt + Shift + G（或Alt + Insert 并选择Create JavaDocs for all elements）李>

（需要注意的是，它只为公共方法生成 javadoc，而不是为字段和私有方法生成）

Answer 2

Javadoc 生成（编写 .html 文件）是按需为您完成的（工具->生成 Javadoc），并且在您设置后基本上是自动的。生成 javadoc stubs，这就是 jautodoc for Eclipse 所做的，是逐个方法、逐个类地完成的，并且只在你告诉它的地方完成。

在方法签名上方键入/** <enter> 将为您创建Javadoc 存根。我怀疑您想要一些可以为整个文件、包或项目执行此操作的东西（例如 jautodoc）。以前有这样一个插件：http://plugins.intellij.net/plugin/?id=952，但是10就不行了。

我不得不说，这个 jautodoc 示例虽然是一个巧妙的聚会技巧，但却是我在 IDE 中见过的最没用的东西：它根据变量名创建描述 - 但前提是变量名描述性如此之强，以至于一开始就不需要评论。

/**
 * The number of questions
 */
private int numberOfQuestions;

让你向往打孔卡。