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

Question

我試圖記錄一種方法並嘗試使用@link和@code，如在JavaDoc中所述。

我知道在科特林有一個kDoc，但我無法找到他們，或者至少類似的東西。

Answer 1

@link和@code在kDoc中不存在，但很容易被Inline Markup替代。

從KotlinDoc Linking to Elements

內標記

對於內標記，KDOC使用常規Markdown語法，擴展到支持 用於鏈接到在代碼其他元素的速記語法。

鏈接到元素

要鏈接到另一個元素（類，方法，屬性或參數）， 乾脆把它放在方括號名稱：

用於此目的的方法[foo]。

如果要指定自定義標籤 的鏈接，使用降價的參考樣式語法：

使用[this method][foo]用於這一目的。您也可以在鏈接中使用合格的 名稱。需要注意的是，不同的JavaDoc，合格的名字總是 使用點字，甚至之前的方法 名的組分分離，：

使用[kotlin.reflect.KClass.properties]枚舉的 類的屬性。鏈接中的名稱使用相同的規則進行解析，就好像在要記錄的元素內使用了名稱 一樣。特別是，這 意味着如果您導入了一個名字到當前文件，你 不需要當你在一個KDOC評論用它來完全限定它。

注意KDOC沒有在聯繫解決所重載 成員的任何語法。由於科特林文檔生成工具把 文檔中關於函數的所有重載在同一頁上， 識別特定重載函數不需要的 鏈接工作。