为Android Studio中的方法生成KDoc

Question

在Android Studio中为Java注释方法时,我可以输入/**并且AS为我生成带有方法参数和返回类型的javadoc.但它似乎对Kotlin不起作用.

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

编辑:是的,这个问题与可能重复的问题大致相同,但我的问题不是"为什么？",我知道KDoc有不同的格式.我的问题是,如果有一种方法可以为AS中的Kotlin做同样的事情吗？也许有办法添加/编辑这个模板或类似的东西？

Answer 1

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

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

生成类和方法KDoc的插件。

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

当您/** 在编写的方法上方输入文件时，然后按Enter键，您将得到类似于以下内容的信息：

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

}

要直接在Android Studio中安装此插件，请执行以下操作：

1. 打开文件/设置（Mac：AndroidStudio /首选项）
2. 选择插件
3. 单击浏览存储库...
4. 在搜索栏中输入“ kdoc-generator”
5. klick安装
6. 重新启动Android Studio现在，已安装kdoc-generator，您可以直接使用它。

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

https://github.com/Kotlin/dokka

Dokka是Kotlin的文档引擎，其功能与Java的javadoc相同。与Kotlin本身一样，Dokka完全支持混合语言Java / Kotlin项目。它了解Java文件中的标准Javadoc注释和Kotlin文件中的KDoc注释，并可以生成多种格式的文档，包括标准Javadoc，HTML和Markdown。

Answer 2

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