在Android Studio中为方法生成KDoc

Question

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

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

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

Answer 1

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

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

用于生成类和方法KDoc的

插件。

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

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

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

}

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

AndroidStudio/Preferences)

• choose

• 打开文件/设置(Mac: searchbar

• klick Install

• restart Plugins

1. 点击searchbar
2. klick Install
3. restart
   1. 中的浏览

   “kdoc-生成器”，现在kdoc-生成器已安装完毕，您可以直接使用它。

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

https://github.com/Kotlin/dokka

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

Answer 2

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