Dokka 快速入门

以下是帮助你快速入门 Dokka 的简单说明。

Gradle Kotlin DSLGradle Groovy DSLMaven

本指南适用于 Dokka Gradle 插件 (DGP) v2 模式。不再支持 DGP v1 模式。 要从 v1 升级到 v2 模式，请参阅迁移指南。

应用 Gradle Dokka 插件

在项目的根构建脚本中应用 Dokka Gradle 插件 (DGP)：

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

为多项目构建生成文档

在为多项目构建生成文档时，需要将插件应用到每个你想要生成文档的子项目。通过以下方式之一在子项目间共享 Dokka 配置：

• 规范插件
• 如果不使用规范插件，则在每个子项目中直接配置

有关在多项目构建中共享 Dokka 配置的更多信息，请参阅多项目配置。

生成文档

要生成文档，请运行以下 Gradle 任务：

./gradlew :dokkaGenerate

此任务适用于单项目和多项目构建。

通过在任务前加上其项目路径 (:)，从聚合项目中运行 dokkaGenerate 任务。例如：

./gradlew :dokkaGenerate

// 或者

./gradlew :aggregatingProject:dokkaGenerate

避免运行 ./gradlew dokkaGenerate，而应运行 ./gradlew :dokkaGenerate 或 ./gradlew :aggregatingProject:dokkaGenerate。如果没有项目路径 (:) 前缀，Gradle 会尝试运行整个构建中的所有 dokkaGenerate 任务，这可能会触发不必要的工作。

你可以使用不同的任务来生成 HTML、Javadoc 或 HTML 和 Javadoc 格式的输出。

要了解更多关于在 Gradle 中使用 Dokka 的信息，请参阅 Gradle。

本指南适用于 Dokka Gradle 插件 (DGP) v2 模式。不再支持 DGP v1 模式。 要从 v1 升级到 v2 模式，请参阅迁移指南。

应用 Gradle Dokka 插件

在项目的根构建脚本中应用 Dokka 的 Gradle 插件：

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

为多项目构建生成文档

在为多项目构建生成文档时，你需要将插件应用到每个你想要生成文档的子项目。通过以下方式之一在子项目间共享 Dokka 配置：

• 规范插件
• 如果不使用规范插件，则在每个子项目中直接配置

有关在多项目构建中共享 Dokka 配置的更多信息，请参阅多项目配置。

生成文档

要生成文档，请运行以下 Gradle 任务：

./gradlew :dokkaGenerate

此任务适用于单项目和多项目构建。

通过在任务前加上其项目路径，从聚合项目中运行 dokkaGenerate 任务。例如：

./gradlew :dokkaGenerate

// 或者

./gradlew :aggregatingProject:dokkaGenerate

避免运行 ./gradlew dokkaGenerate，而应运行 ./gradlew :dokkaGenerate 或 ./gradlew :aggregatingProject:dokkaGenerate。如果没有项目路径 (:) 前缀，Gradle 会尝试运行整个构建中的所有 dokkaGenerate 任务，这可能会触发不必要的工作。

你可以使用不同的任务来生成 HTML、Javadoc 或 HTML 和 Javadoc 格式的输出。

要了解更多关于在 Gradle 中使用 Dokka 的信息，请参阅 Gradle。

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

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

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

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

要了解更多关于在 Maven 中使用 Dokka 的信息，请参阅 Maven。