生成 Kotlin 方法/类注释

Question

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

/**

在 IntelliJ IDEA 2016.1.3 中按 Enter 似乎不起作用

Dokka 好像已经取代了 KDoc，但是为什么 IntelliJ 没有支持呢？还是我错过了什么？

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

/**
 *
 */

但我想知道为什么不添加 @param 和其他的生成（就像 IntelliJ 为 Java 所做的那样）。这些注释也用于记录 Kotlin 代码 (https://kotlinlang.org/docs/reference/kotlin-doc.html)

Answer 1

为了扩展@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) = ...

Answer 2

@param 和其他标签不会生成，因为 Kotlin 的推荐文档样式是使用 [foo] 语法从文档注释文本中引用参数名称，而不是使用显式的 @param 标签来记录它们。您可以查看Kotlin standard library documentation 了解如何使用此样式。