文档模板生成kotlin

Question

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

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

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

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

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

Answer 1

Kotlin，尤其是KDoc鼓励采用不同的文档风格。如本次讨论所述：

原因是我们发现，与传统的javadoc风格相比，从文档文本中引用参数名称可以编写更简洁、更易于阅读的文档，而传统的javadoc风格将每个参数记录在一个单独的标记中。因此，默认情况下，我们不会生成带有参数名的模板。（D.杰梅洛夫，《科特林在行动》作者）

下面是一个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