【问题标题】:In Kotlin documentation (KDoc), is it possible to link to a specific overloaded method?在 Kotlin 文档 (KDoc) 中,是否可以链接到特定的重载方法?
【发布时间】:2019-12-18 21:08:56
【问题描述】:

考虑这个 Kotlin 类的类注释

/**
 * This class has two methods, one that takes one parameters ([foo]),
 * and another one that takes two parameters ([foo]).
 **/
class Clazz {
    /* Foo with one. */
    fun foo(a: Int) {  }

    /* Foo with two. */
    fun foo(a: Int, b: Int) {  }
}

我希望第二个链接指向第二个函数(具有两个参数的函数)。

这在 Kotlin 文档语言中是否可行?

【问题讨论】:

标签: kotlin kdoc dokka


【解决方案1】:

刚刚找到这个答案:

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

来自https://kotlinlang.org/docs/reference/kotlin-doc.html

...但我不太明白其中的原因。

在将文档与代码分开读取的上下文中,这听起来很有意义,但大多数时候,当我阅读或使用 cmets 时,它是在 IDE UI 中。

【讨论】:

    猜你喜欢
    • 2015-04-16
    • 2020-05-16
    • 2013-06-14
    • 2010-10-07
    • 2016-02-09
    • 1970-01-01
    • 2019-07-01
    • 2021-07-18
    • 2020-08-30
    相关资源
    最近更新 更多