为 Android Studio 中的方法生成 KDoc [关闭]答案

【问题标题】：Generate KDoc for methods in Android Studio [closed]为 Android Studio 中的方法生成 KDoc [关闭]
【发布时间】：2017-03-27 05:33:22
【问题描述】：

在 Android Studio 中为 Java 注释方法时，我可以输入 /**，AS 会为我生成带有方法参数和返回类型的 javadoc。但它似乎不适用于 Kotlin。

有没有办法教 AS 自动生成 Kotlin KDoc 格式的方法文档？

编辑：是的，这个问题与可能的重复问题大致相同，但我的问题不是“为什么？”，我知道 KDoc 有不同的格式。我的问题是是否有办法在 AS 中为 Kotlin 做同样的事情？也许有一种方法可以添加/编辑这个模板或类似的东西？

【问题讨论】：

Generating Kotlin method/class comments的可能重复
您当然可以编写自己的插件来为您生成这些标签。除此之外，没有任何可能。
试试这个方法stackoverflow.com/a/41589000/2267723
我不同意这个问题是题外话。新的 Kotlin 开发人员肯定会质疑如何在他们的方法上生成 KDoc cmets，等等。@Shorxy 的回答对我来说非常有用。
我认为这完全不是题外话。然而，这两个问题或多或少都要求相同的答案，这意味着一个是另一个的重复。事件虽然@Ryan M 提到的问题较旧，但该问题应标记为重复。

标签： android-studio kotlin

【解决方案1】：

自 2019 年 1 月起，Jetbrains 网站上有一个名为 kdoc-generator 的插件。

https://plugins.jetbrains.com/plugin/10389-kdoc-generator

生成类和方法 KDoc 的插件。

此生成器的功能与 JavaDoc 完全相同。这意味着，当您使用“/**”创建注释并按 Enter 键时，kdoc 生成器会自动为参数创建“@param”或“@return”标签，并直接在此创建的注释下方创建方法的返回值。

当你输入/** 在您编写的方法上方的文件中，然后按回车键，您会得到类似于以下内容的内容：

/**
 *
 * @param str 
 * @param age
 */
fun foo(str: String, age: Int) {

}

直接在 Android Studio 中安装此插件：

打开文件/设置（Mac：AndroidStudio/Preferences）
选择插件
单击浏览存储库...
在搜索栏中输入“kdoc-generator”
点击安装
重启Android Studio 现在kdoc-generator已经安装好了，可以直接使用了。

此外，Jetbrains 还为 Kotlin 开发了一个文档引擎，您可以使用该引擎将 Kotlin 文件中的文档转换为一些标准格式，例如HTML

https://github.com/Kotlin/dokka

Dokka 是 Kotlin 的文档引擎，执行与 Java 的 javadoc 相同的功能。就像 Kotlin 本身一样，Dokka 完全支持混合语言的 Java/Kotlin 项目。它可以理解Java文件中的标准Javadoc cmets和Kotlin文件中的KDoc cmets，并且可以生成包括标准Javadoc、HTML和Markdown在内的多种格式的文档。

【讨论】：

它在 JetBrains 网站上的事实并不意味着它是由 JetBrains 开发的。供应商名称为“siosio”，AndroidStudio 发出警告，表示它可能会处理我的敏感数据。谢谢，但没有。
哦，谢谢你指出这一点。我马上修好了。

【解决方案2】：

由于这很可能是 IntelliJ 的错误，因此我冒昧地提交错误报告 here。您可以选择观看此问题以获取任何更新的通知。

【讨论】：

不，这不是错误。请参阅链接的问题以获取更多信息。