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

Question

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

Answer 1

如果您想使用Dokka生成您的文檔，您可以為每個包創建一個帶有標頭的單個 markdown ( .md ) 文件（或者可能在每個包中使用單獨的 markdown 文件，在該文件中為該包創建一個標頭）：

我的包-docs.md：

# Package com.example.mylibrary.firstpackage

This is the docs for firstpackage.

# Package com.example.mylibrary.anotherpackage

This is the docs for anotherpackage.

## This is a subheader for anotherpackages docs

通過使用-include命令行參數或 Ant、Maven 和Gradle 插件中的相應參數將文件的路徑傳遞給 Dokka，將 Markdown 文件包含在 Dokka 結果文檔中。

這是我的庫build.gradle.kts文件 ( Kotlin DSL ) 中 Dokka 的示例配置：

tasks.dokkaHtml.configure {
    dokkaSourceSets {
        configureEach { // OR named("main") {
            includes.from("my-packages-docs.md", "another.md")
            ...
        }
    }
}

有關更多信息，請參閱Kotlin 文檔。