Question

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

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

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

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

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

Answer 1

Kotlin尤其是KDoc鼓励使用不同的文档样式。正如本discussion所述：

原因是我们发现，与传统的javadoc样式相比，引用文档文本中的参数名称可以编写更简洁，更易于阅读的文档，其中每个参数都记录在单独的标记中。因此，默认情况下我们不生成带参数名称的模板。（D. Jemerov，Kotlin in Action Author）

以下是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

文档模板生成kotlin

1 个答案: