如何在kotlin kDoc中使用@link和@code

我试图文档的方法，并尝试使用@连接和@code在JavaDoc中 。

我知道kotlin有一个kDoc，但我找不到它们，或者至少是类似的东西。

Answer 1

@link和@code在kDoc中不存在，但很容易被Inline标记替换。

从KotlinDoc 链接到元素

内联标记

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

链接到元素

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

为此，使用方法[foo] 。

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

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

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

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