如何用Kotlin Dokka记录主构造参数
比方说,有一个类的主要构造函数有参数param
,我想解决(链接到实际的参数)在类的文档块。
/** Class A does something using [param]. @constructor constructs A with [param]. */ class A (param: Int)
但是,题注param
被IDE强调说它不能解析符号param
。
实际上,如果您在@constructor
段落中使用[param]
引用该参数,dokka正确地find该参数,则可以通过检查组合文档中显示的URL来检查该参数,如下所示:
file:///.../some.package/-a/-init-.html#some.package.A$(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)