Dokka

Dokka是一个Kotlin的API文档引擎。

就像Kotlin本身一样,Dokka支持多语言项目。它理解Kotlin的KDoc注释和Java的Javadoc注释。

Dokka可以生成多种格式的文档,包括其自身的现代HTML格式,多种风格的Markdown,以及Java的Javadoc HTML。

一些使用Dokka来生成API参考文档的库包括:

您可以使用Gradle、Maven或者命令行运行Dokka。它也是高度可插拔的。

文档

Dokka的全面文档可在kotlinlang.org上获得。

开始使用Dokka

Gradle

Kotlin DSL

在项目根build脚本中应用Gradle的Dokka插件:

plugins {
    id("org.jetbrains.dokka") version "1.9.20"
}

当文档多项目构建时,您需要在子项目中也应用Gradle的Dokka插件:

subprojects {
    apply(plugin = "org.jetbrains.dokka")
}

Groovy DSL

在根项目中应用Gradle的Dokka插件:

plugins {
    id 'org.jetbrains.dokka' version '1.9.20'
}

当文档多项目构建时,您需要在子项目中也应用Gradle的Dokka插件:

subprojects {
    apply plugin: 'org.jetbrains.dokka'
}

要生成文档,请运行以下Gradle任务:

dokkaHtml 用于单个项目构建
dokkaHtmlMultiModule 用于多项目构建

默认情况下，输出目录分别设置为 /build/dokka/html 和 /build/dokka/htmlMultiModule。

要了解有关 Dokka 的 Gradle 插件的更多信息，请参见 Gradle 文档。

Maven

将 Dokka Maven 插件添加到您的 POM 文件的 plugins 部分:

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>1.9.20</version>
            <executions>
                <execution>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>dokka</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

要生成文档，请运行 dokka:dokka 目标。

默认情况下，输出目录设置为 target/dokka。

要了解如何将 Dokka 与 Maven 一起使用的更多信息，请参见 Maven 文档。

CLI

也可以直接从命令行运行 Dokka，而不需要使用任何构建工具，但设置起来更加困难，所以本节中没有涉及。

请查阅命令行运行程序文档了解如何使用它。

Android

除了应用和配置 Dokka 之外，您还可以应用 Dokka 的 Android 文档插件，它旨在改善 Android 平台上的文档体验:

Gradle Kotlin DSL

dependencies {
    dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.20")
}

Gradle Groovy DSL

dependencies {
    dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.20'
}

Maven

<plugin>
    <groupId>org.jetbrains.dokka</groupId>
    <artifactId>dokka-maven-plugin</artifactId>
    ...
    <configuration>
        <dokkaPlugins>
            <plugin>
                <groupId>org.jetbrains.dokka</groupId>
                <artifactId>android-documentation-plugin</artifactId>
                <version>1.9.20</version>
            </plugin>
        </dokkaPlugins>
    </configuration>
</plugin>