文档模板生成 kotlin

【问题标题】：Document template generation kotlin文档模板生成 kotlin
【发布时间】：2018-07-14 03:12:23
【问题描述】：

在Android Studio中工作之前如果在我输入/**并回车的函数之前，我会自动生成下一个带有注释的文档，用于描述参数、返回值等。

/**
* @params a
* @return
*/
int f(int a)
{
    return a;
}

当我开始在 Android Studio 中使用 Kotlin 时，我尝试生成一个类似的模板，它会生成没有返回、参数等的空白模板。

   /**
    *
    */
    fun f(a: Int)
    {
       return a
    }

我安装了 Dokka 并尝试在 Android Stuio 中进行设置，但没有成功。如何在 Android Studio 中为 Kotlin 配置类似模板的生成？

【问题讨论】：

标签： android android-studio kotlin kdoc

【解决方案1】：

Kotlin 尤其是 KDoc 鼓励不同的文档风格。如discussion中所述：

原因是我们发现，与传统的 javadoc 风格相比，从文档文本中引用参数名称可以编写更简洁、更易于阅读的文档，每个参数都记录在单独的标签中时间>。因此，我们默认不生成带有参数名称的模板。（D. Jemerov，Kotlin in Action 作者）

这是一个let 的示例，它是标准库的一部分：

/**
 * Calls the specified function [block] with `this` value as its argument and returns its result.
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.let(block: (T) -> R): R

【讨论】：