如何使用 Kotlin Dokka 记录主构造函数参数
How to document a primary constructor parameter with Kotlin Dokka
假设有一个 class，它的主构造函数具有我想在 [=18= 的文档块中解析（链接到实际参数）的参数 param ].
/** Class A does something using [param].
@constructor constructs A with [param].
*/
class A (param: Int)
然而，铭文 param 被 IDE 突出显示，表示它无法解析符号 param。
实际上，如果您在 @constructor 段落中使用 [param] 引用它，dokka 会正确找到参数，您可以通过检查汇编文档中出现的 URL 来检查，看起来像：
file:///.../some.package/-a/-init-.html#some.package.A$<init>(kotlin.Int)/param
看起来，有关未解析引用的警告是 IDE 对 KDoc 支持的问题。请在 kotl.in/issue.
举报
另一种选择是在 class KDoc 中使用 @param：
/**
* Class A does something using [param].
* @param param means something special.
*/
class A (param: Int)
假设有一个 class，它的主构造函数具有我想在 [=18= 的文档块中解析（链接到实际参数）的参数 param ].
/** Class A does something using [param].
@constructor constructs A with [param].
*/
class A (param: Int)
然而，铭文 param 被 IDE 突出显示，表示它无法解析符号 param。
实际上，如果您在 @constructor 段落中使用 [param] 引用它，dokka 会正确找到参数，您可以通过检查汇编文档中出现的 URL 来检查，看起来像：
file:///.../some.package/-a/-init-.html#some.package.A$<init>(kotlin.Int)/param
看起来，有关未解析引用的警告是 IDE 对 KDoc 支持的问题。请在 kotl.in/issue.
举报另一种选择是在 class KDoc 中使用 @param：
/**
* Class A does something using [param].
* @param param means something special.
*/
class A (param: Int)