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

Question

假设有一个类主要构造函数具有param我想要在类的doc块中解析(链接到实际参数)的参数.

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

但是,paramIDE会突出显示题词,表示无法解析符号param.

Answer 1

实际上，如果您[param]在本@constructor段中引用了dokka，则dokka可以正确找到该参数，您可以通过检查组合文档中出现的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)