在kDoc中使用@link和别名

Question

在Java文档中，我可以执行以下操作：

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

我该如何在Kotlin文档中实现相同的结果？

Answer 1

@link在kDoc中不存在，但可以很容易地用Inline Markup替换。

来自KotlinDoc Linking to Elements

  

内联标记

     

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

     

链接到元素

     

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

     

为此使用方法[foo]。

     

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

     

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

     

使用[kotlin.reflect.KClass.properties]来枚举   班级。链接中的名称使用与   名称用于记录的元素内。特别是这个   表示如果您将名称导入到当前文件中，则表示   当您在KDoc注释中使用它时，不需要完全限定它。

     

请注意，KDoc没有用于解决重载的任何语法   链接中的成员。由于Kotlin文档生成工具   同一页面上所有函数重载的文档，   不需要识别特定的重载功能   链接到工作。