android-studio - 为 Android Studio 中的方法生成 KDoc

Question

已结束。此问题不符合 Stack Overflow guidelines .它目前不接受答案。

---

我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。

关闭 3 年前。

Improve this 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

Plugin to generate class and method KDoc.

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

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

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

}

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

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

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

https://github.com/Kotlin/dokka

Dokka is a documentation engine for Kotlin, performing the same function as javadoc for Java. Just like Kotlin itself, Dokka fully supports mixed-language Java/Kotlin projects. It understands standard Javadoc comments in Java files and KDoc comments in Kotlin files, and can generate documentation in multiple formats including standard Javadoc, HTML and Markdown.