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

Question

假设有一个类，它的主构造函数有参数 param 我想在类的 doc block 中解析(链接到实际参数)。

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

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

Answer 1

实际上，如果您在 @constructor 段落中使用 [param] 引用它，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)