android-studio - Using @link with aliases in kDoc

Question

In Java documentation I can do the following:

/**
*  {@link FancyComp mFancy} is a variable that you need
*/

How do I do this in Kotlin doc for the same result of course?

Answer 1

@linkkDoc 中不存在，但可以很容易地被Inline Markup替换。

从 KotlinDoc链接到元素

内联标记

对于内联标记，KDoc 使用常规Markdown语法，扩展为支持用于链接到代码中其他元素的速记语法。

链接到元素

要链接到另一个元素（类、方法、属性或参数），只需将其名称放在方括号中：

[foo]为此目的使用该方法。

如果要为链接指定自定义标签，请使用 Markdown 引用样式语法：

用于[this method][foo]此目的。您还可以在链接中使用限定名称。请注意，与 JavaDoc 不同，限定名称始终使用点字符来分隔组件，即使在方法名称之前也是如此：

用于[kotlin.reflect.KClass.properties]枚举类的属性。链接中的名称使用相同的规则解析，就好像该名称在被记录的元素中使用一样。特别是，这意味着如果您已将名称导入当前文件，则在 KDoc 注释中使用它时无需完全限定它。

请注意，KDoc 没有任何语法来解析链接中的重载成员。由于 Kotlin 文档生成工具将函数的所有重载的文档放在同一页面上，因此链接工作不需要识别特定的重载函数。