在Kotlin文档(KDoc)中,是否可以链接到特定的重载方法?

19

考虑这个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文档语言中是否可能实现这一点?


3
相关的错误/缺失功能 - Roland
1
请参见 KT-15984 - Bass
1个回答

24

刚刚发现了这个答案:

请注意,KDoc没有为解决链接中的重载成员提供任何语法。由于 Kotlin 文档生成工具将函数所有重载的文档放置在同一页上,因此标识特定的重载函数并不需要使链接起作用。

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

...但我实际上不太理解这个推理。

听起来这在文档与代码分离的情况下是有意义的,但大多数时候当我读取或使用注释时都是在IDE UI中进行的。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接