生成Kotlin方法/类注释

Question

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

/**

推送输入似乎在IntelliJ IDEA 2016.1.3

中不起作用

似乎Dokka取代了KDoc，但为什么IntelliJ没有支持？或者我错过了什么？

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

/**
 *
 */

但是我想知道为什么没有添加@param和其他的一代（就像IntelliJ对Java一样）。这些注释也用于记录Kotlin代码（https://kotlinlang.org/docs/reference/kotlin-doc.html）

Answer 1

未生成@param和其他标记，因为Kotlin的推荐文档样式是使用[foo]语法从doc注释文本引用参数名称，而不是使用explicit {来记录它们{1}}标签。您可以查看Kotlin standard library documentation以查看此样式的使用方式。

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) = ...