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

Question

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

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

但是，IDE 突出显示了该铭文param，说它无法解析 symbol param。

Answer 1

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

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

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

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

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