假设有一个类,其主构造函数具有参数param
,我希望在类的文档块内解析(链接到实际参数)该参数。
/** Class A does something using [param].
@constructor constructs A with [param].
*/
class A (param: Int)
然而,IDE指出无法解析符号param
,但这个标记param
仍需保留。
然而,IDE指出无法解析符号param
,但这个标记param
仍需保留。
假设有一个类,其主构造函数具有参数param
,我希望在类的文档块内解析(链接到实际参数)该参数。
/** Class A does something using [param].
@constructor constructs A with [param].
*/
class A (param: Int)
然而,IDE指出无法解析符号param
,但这个标记param
仍需保留。
然而,IDE指出无法解析符号param
,但这个标记param
仍需保留。
实际上,如果您在@constructor
段落中使用[param]
引用参数,则dokka会正确找到该参数。您可以通过检查组装文档中出现的URL进行验证,该URL如下所示:
file:///.../some.package/-a/-init-.html#some.package.A$<init>(kotlin.Int)/param
看起来,未解决的引用警告是与KDoc的IDE支持有关的问题。请在kotl.in/issue上报告它。
另一个选项是在类KDoc中使用@param
:
/**
* Class A does something using [param].
* @param param means something special.
*/
class A (param: Int)
constructor
标识符并将其视为方法。但我想避免混乱。 - Markus Marvell