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

Question

假设有一个类，其主构造函数具有参数param，我希望在类的文档块内解析（链接到实际参数）该参数。

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

然而，IDE指出无法解析符号param，但这个标记param仍需保留。

Translated:

然而，IDE指出无法解析符号param，但这个标记param仍需保留。

- Markus Marvell

---

有趣。这个代码很好用，除了IDE警告之外。如果我在“param”前面添加“val”或“var”，它就会消失（当然也变成了属性）- 如果我以这种方式记录方法参数，我就不会收到警告。 - Adam S

@AdamS 这就是属性和方法参数的预期工作方式。我可以在主构造函数之前添加一个 constructor 标识符并将其视为方法。但我想避免混乱。 - Markus Marvell

Answer 1

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

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

看起来，未解决的引用警告是与KDoc的IDE支持有关的问题。请在kotl.in/issue上报告它。

另一个选项是在类KDoc中使用@param：

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

- hotkey