生成静态编程语言方法/类注释

Question

如何为方法/类生成注释？只需输入：

/**

推入似乎在IntelliJ IDEA 2016.1.3中不起作用

看起来Dokka已经取代了KDoc，但为什么IntelliJ中没有支持？还是我错过了什么？

澄清：当输入/**enter时，会生成：

/**
 *
 */

但是我想知道为什么没有添加@参数和其他的生成（就像IntelliJ为Java所做的那样）。这些注释也用于记录静态编程语言代码（https://kotlinlang.org/docs/reference/kotlin-doc.html）

Answer 1

不会生成@param和其他标记，因为Kotlin的推荐文档样式是使用[foo]语法引用文档注释文本中的参数名称，而不是使用显式@param标记对其进行文档记录。您可以查看Kotlin标准库文档，了解如何使用这种样式。

Answer 2

为了进一步阐述@yole的回答和@Charles A.的评论，下面是创建KDocs时首选格式的完整解释，以及它与JavaDocs的不同之处。

Kotlin文档如下：

https://kotlinlang.org/docs/reference/coding-conventions.html#documentation-comments

...说：

通常，避免使用@param和@return标记。相反，将参数和返回值的描述直接合并到文档注释中，并在提到参数的地方添加参数链接。仅当需要较长的描述且不符合正文流程时，才使用@param和@return。

避免这样做：

/**
 * Returns the absolute value of the given number.
 * @param number The number to return the absolute value for.
 * @return The absolute value.
 */
fun abs(number: Int) = ...

改为这样做：

/**
 * Returns the absolute value of the given [number].
 */
fun abs(number: Int) = ...