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

Question

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

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

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

Answer 1

实际上，如果您在[param]段落中使用@constructor引用该参数，dokka会正确找到该参数，您可以通过检查汇编文档中显示的网址来检查该参数，如下所示：

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)