在 KDoc 中記錄屬性

[英]Documenting properties in KDoc

我看到很多代碼，它們使用標簽@property來記錄屬性：/** * Some Class * * @property p Some property */ class C { val p = 42 } 但我更喜歡在定義的地方記錄屬性：/** Some Class */ class C ...

在哪里可以找到 Jetpack Compose 源文檔引用的示例？

[英]Where do I find the samples referred to by Jetpack Compose source documentation?

KDoc 包含一些 package 和 Kotlin 文件的鏈接，但我實際上看不到這些包和文件文檔 window 截圖我查看了 Google Maven 存儲庫，期望發現我只是沒有在我的 build.gradle 中包含一些build.gradle ，但也沒有這樣的工件 ...

Android 庫缺少有關 Android 工作室 Kdoc Dokka 的文檔

[英]Android library missing documentation on Android studio Kdoc Dokka

當我從 maven 導入我的庫時，沒有關於 Android Studio/IntelliSense 的可用文檔。 即使我正確設置了 Dokka 並且 javadoc.jar 存在於 maven 存儲庫中，仍然無法使其工作。 這是 gradle 腳本： 所有文檔都在 Kdoc 中，我是否遺漏了什么？ ...

使用 KDoc 注釋變量的正確方法是什么？

[英]What is the proper way to annotate variable with KDoc?

我試圖像 @property 一樣進行注釋，但這是不對的。 多卡不承認例如枚舉： ...

如何在 Jitpack 上使用 maven 為 Kotlin 庫發布 KDoc？

[英]How do you publish KDoc for a Kotlin library using maven on Jitpack?

背景經過大量的研究和嘗試，並尋求幫助，我成功地在 Jitpack 上使用 maven 發布了一個私有 Github 存儲庫（寫在這里）。 所以，目前我放在 Jitpack 存儲庫中的文件就是這些： jitpack.yml - 告訴使用哪些文件 library-release.aar - （混淆的 ...

Kotlin 文檔：鏈接到具有不同簽名的方法？

[英]Kotlin Documentation: Link to methods with different signatures?

在 Java 中，我們有這樣的內容： 點擊鏈接采取不同的方法。 我可以在某種程度上實現第一個鏈接： 我還嘗試了另一個示例（檢查它是否不是僥幸） 我一直在 Android Studio 上嘗試這些。 Koltin 鏈接不可直接點擊，但如果在“渲染視圖”（使用 Ctrl+Alt+Q）中看到文檔，則會 ...

kotlin kdoc中的參考資源不可點擊

[英]Reference resources in kotlin kdoc are not clickable

我想在我的 Javadoc 中提到一個布局，它從 java 轉換為 Kotlin。 在 java 中是： 這是可點擊的，但是當我使用 android 工作室工具轉換此 class 時。 改為： 這是不可點擊的。 我怎樣才能讓它可點擊？ ...

KDoc 是否有最大行長？

[英]Is there a maximum line length for KDoc?

在 JavaDoc 中，行數不得超過 80 個字符（不包括表達式中未顯示的部分，如{@code}和{@link} ）。 KDoc 有行長限制嗎？ 它當然不是 80，因為我在 stdlib 中發現了長達 112 個字符的行。 有人知道嗎？ ...

如何為 Kotlin 擴展函數的接收者添加 KDoc 注釋（Java 中的第一個參數，Kotlin 中的“this”）

[英]How to add a KDoc comment for the receiver of a Kotlin extension function (first parameter in Java, `this` in Kotlin)

考慮這個非擴展函數： 當我在 kotlin 和 java 中使用這個函數時，我可以看到它的參數名稱： expression 。 我也可以編寫與擴展函數相同的功能： 當我以這種方式將其編寫為擴展函數時，調用它的布爾值的參數名稱（函數中的this變量，也稱為接收器）顯示為$this$check ...

Kotlin 生成 Kdoc 的問題

[英]Kotlin probleme with generating Kdoc

嗨，我在使用 Kdoc 時遇到了問題，所以我遵循了這個： https ://blog.jetbrains.com/kotlin/2020/08/dokka-preview-based-on-kotlin-1-4-0-rc/ 我能夠在 gradle 基礎項目中添加插件，然后在終端上使用命令./grad ...

"KDoc \/ Dokka：忽略子類中的繼承方法"

[英]KDoc / Dokka: Ignore inherited methods in subclass

我正在使用 KDoc\/Dokka 為 android 庫生成文檔。 我有一個自定義視圖，它擴展了LinearLayout<\/code> 。 問題是LinearLayout<\/code>包含數百個公共方法。 Dokka 為所有這些方法生成空文檔，即使我沒有在我自己的代碼 ...

無法使用 Dokka 生成 Kdoc

[英]Unable to generate Kdoc using Dokka

我正在嘗試在 Android 項目中生成 KDoc 文檔。 以下是添加此功能的相關文件。 build.gradle （根級）： build.gradle （模塊：App） 后來，我從命令行運行./gradlew dokka 。 但是沒有生成 output。 以下是我得到的： 其實MainAct ...

如何在 Kotlin 代碼上強制執行完整的文檔

[英]How to enforce complete documentation on Kotlin code

我應該使用什么插件或工具來對新的 Kotlin 代碼強制執行完整的 kdoc 文檔？ Java 代碼通過 checkstyle 和 Sun 的規則集進行檢查，我需要一個 Kotlin 的類似物。 ...

在 iOS/XCode 的 built.frameworks 中包含 Kotlin/Native KDocs 文檔

[英]Include Kotlin/Native KDocs documentation in built .frameworks for iOS/XCode

我正在為 iOS 和 Android 開發一個 Kotlin/Native 庫。 運行./gradlew assemble時，我得到了帶有 Obj-C 標頭的 release/debug .framework 。 我可以很好地使用這些.framework 。 但在使用 XCode 上的代碼時，我還想 ...

在 Kotlin 文檔 (KDoc) 中，是否可以鏈接到特定的重載方法？

[英]In Kotlin documentation (KDoc), is it possible to link to a specific overloaded method?

考慮這個 Kotlin 類的類注釋： 我希望第二個鏈接指向第二個函數（帶有兩個參數的函數）。 這在 Kotlin 文檔語言中是可能的嗎？ ...

KDoc：更改參數順序

[英]KDoc: change parameters order

我在 Kotlin 上的配套 object中有以下參數 問題是，在Kdoc結果中，我按字母順序找到它們 ARTIST_IDS_KEY const val ARTIST_IDS_KEY：字符串 CONNECTION_AUX const val CONNECTION_AUX：字符串 CONNECTI ...

如何在 KDoc 中引用輔助構造函數？

[英]How do I reference a secondary constructor in KDoc?

我有一個帶有輔助構造函數的 Kotlin class，它應該用於特定場景。 現在這應該從第一個構造函數中正確記錄，以便您可以立即看到它。 我一點也不知道在方括號中放什么用於引用成員/函數，但我覺得應該是可能的。 如果有人對此了解更多，那就太好了 ...

Dokka：將代碼示例包含到 package 文檔中

[英]Dokka: include code samples into package documentation

如何在 Dokka package 文檔中包含（經過測試的、非陳舊的）代碼示例？ 更具體地說，假設我在build.gradle.kts中有這個配置： 然后是一些測試代碼： 還有一個 package 文檔 Markdown 文件： ，如何將println(...) -part 包含到文檔中？ 當前版 ...

如何在 Android 中離線運行 Dokka

[英]How to run Dokka offline in Android

我想離線運行 Dokka 以生成文檔，因為構建運行系統不需要互聯網訪問，因此需要離線生成文檔。 是否可以？ 如果是，請建議相同。 謝謝比奈 由於它似乎不能離線工作，因此沒有可用的信息。 ...

如何在 IntelliJ IDEA/Gradle 項目中使用 Java `package-info.java` 記錄 Kotlin 包？

[英]How do I document a Kotlin package like with the Java `package-info.java` in an IntelliJ IDEA/Gradle project?

kotlinlang.org 說一個單獨的 markdown 文件記錄了所有的包。 IntelliJ IDEA 項目中是否有該降價文件的規范路徑？ 有沒有一種規范的方法來使用 Gradle 處理該文件？ 有沒有辦法將這些 .md 文件與 .kt 文件放在包目錄中？ ...