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

Question

在Android Studio中评论Java方法时，我可以键入/**并生成带有方法参数和返回类型的javadoc。但这似乎对科特林不起作用。

有什么方法可以教你自动生成Kotlin KDoc格式的方法文档吗？

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

Answer 1

由于这很可能是IntelliJ的一个bug，我冒昧地在这里提交了一份bug报告。您可以选择观看此问题以获得任何更新的通知。

Answer 2

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

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

用于生成类和方法KDoc的插件。

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

当你在你写的方法上方的文件中键入/**，然后按enter键时，你会得到类似的结果：

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

}

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

1. 打开文件/设置（Mac：AndroidStudio/首选项）
2. 选择插件
3. 单击浏览存储库...
4. 在搜索栏中输入kdoc生成器
下载安装
5. 重启Android Studio现在安装了kdoc生成器，您可以直接使用它。

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

https://github.com/Kotlin/dokka

dokka是静态编程语言的留档引擎，执行与javadocJava相同的功能。就像静态编程语言本身一样，多卡完全支持混合语言Java/静态编程语言项目。它理解Java文件中的标准Javadoc注释和静态编程语言文件中的KDoc注释，并可以生成多种格式的留档，包括标准Javadoc、超文本标记语言和Markdown。