Android studio 在kDoc中使用带别名的@link
在Java文档中,我可以执行以下操作:Android studio 在kDoc中使用带别名的@link,android-studio,kotlin,kdoc,Android Studio,Kotlin,Kdoc,在Java文档中,我可以执行以下操作: /** * {@link FancyComp mFancy} is a variable that you need */ 当然,我如何在Kotlin文档中这样做才能获得相同的结果?@link在kDoc中不存在,但很容易被替换 来自科特林多克 内联标记 对于内联标记,KDoc使用常规语法,扩展为 支持用于链接到代码中其他元素的速记语法 链接到元素 要链接到另一个元素(类、方法、属性或参数), 只需将其名称放在方括号内: 为此,请使用方法[foo] 如果
/**
* {@link FancyComp mFancy} is a variable that you need
*/
当然,我如何在Kotlin文档中这样做才能获得相同的结果?
@link
在kDoc中不存在,但很容易被替换
来自科特林多克
内联标记
对于内联标记,KDoc使用常规语法,扩展为
支持用于链接到代码中其他元素的速记语法
链接到元素
要链接到另一个元素(类、方法、属性或参数),
只需将其名称放在方括号内:
为此,请使用方法[foo]
如果要指定自定义
对于链接的标签,请使用标记参考样式语法:
为此,请使用[此方法][foo]
。您也可以使用合格的
链接中的名称。注意,与JavaDoc不同,限定名总是
使用点字符分隔组件,甚至在方法之前
姓名:
使用[kotlin.reflect.KClass.properties]
枚举
这个班。链接中的名称使用相同的规则解析,就像
名称已在正在记录的元素中使用。特别是
表示如果已将名称导入当前文件,则
在KDoc注释中使用它时,不需要完全限定它
请注意,KDoc没有任何用于解析重载的语法
链接中的成员。由于Kotlin文档生成工具
同一页上函数的所有重载的文档,
该函数不需要标识特定的重载函数
链接到工作