如何使用 Kotlin Dokka 记录主构造函数参数答案

【问题标题】：How to document a primary constructor parameter with Kotlin Dokka如何使用 Kotlin Dokka 记录主构造函数参数
【发布时间】：2018-02-28 00:42:06
【问题描述】：

假设有一个类，它的主构造函数有参数param，我想在类的 doc 块中解析（链接到实际参数）。

/** Class A does something using [param]. 
@constructor constructs A with [param].
*/
class A (param: Int)

但是，IDE 突出显示了题词 param，表示它无法解析符号 param。

【问题讨论】：

有趣。这工作正常，除了 IDE 警告。如果我在param 之前添加val 或var，它就会消失（当然会成为一个属性）——如果我以这种方式记录方法参数，我不会收到警告。
@AdamS 这就是它对属性和方法参数的作用。我可以在主构造函数之前添加一个constructor 标识符并将其视为一种方法。但我想避免混乱。

【解决方案1】：

实际上，如果您在@constructor 段落中使用[param] 引用它，dokka 会正确找到该参数，您可以通过检查组装文档中出现的 URL 来检查，如下所示：

file:///.../some.package/-a/-init-.html#some.package.A$<init>(kotlin.Int)/param

看起来，关于未解析引用的警告是 IDE 对 KDoc 的支持存在问题。请通过kotl.in/issue举报。

另一种选择是在 KDoc 类中使用 @param：

/** 
 * Class A does something using [param]. 
 * @param param means something special.
*/
class A (param: Int)

【讨论】：