[英]In Kotlin documentation (KDoc), is it possible to link to a specific overloaded method?
考慮這個 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 文檔語言中是可能的嗎?
剛剛找到這個答案:
請注意,KDoc 沒有任何語法來解析鏈接中的重載成員。 由於 Kotlin 文檔生成工具將一個函數的所有重載的文檔放在同一頁面上,因此鏈接工作不需要識別特定的重載函數。
來自https://kotlinlang.org/docs/reference/kotlin-doc.html
……但我真的不明白其中的道理。
在文檔與代碼分開閱讀的上下文中,這聽起來很有意義,但大多數時候,當我閱讀或使用評論時,它是在 IDE UI 中。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.