如何在 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 文档。