Alpha

Javadoc

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

Dokka 的 Javadoc 输出格式是 Java Javadoc HTML 格式的仿制品。

它尝试在视觉上模仿 Javadoc 工具生成的 HTML 页面，但它不是直接实现或完全复制。

所有 Kotlin 代码和签名都从 Java 的视角进行渲染。这是通过我们的 Kotlin as Java Dokka 插件实现的，该插件针对此格式已捆绑并默认应用。

Javadoc 输出格式是以 Dokka 插件的形式实现的，由 Dokka 团队维护。它是开源的，您可以在 GitHub 上找到其源代码。

生成 Javadoc 文档

Dokka 不支持多项目构建或 Kotlin 多平台项目的 Javadoc 格式。

Gradle Kotlin DSLMavenCLI

Dokka Gradle 插件已包含 Javadoc 输出格式。您需要在项目的 build.gradle.kts 文件的 plugins {} 块中应用相应的插件 ID：

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

应用插件后，您可以运行以下任务：

• dokkaGenerate 以根据应用插件生成所有可用格式的文档。
• dokkaGeneratePublicationJavadoc 仅生成 Javadoc 格式的文档。

javadoc.jar 文件可以单独生成。有关更多信息，请参阅构建 javadoc.jar。

Dokka Maven 插件内置了 Javadoc 输出格式。您可以使用以下目标生成文档：

目标	描述
dokka:javadoc	生成 Javadoc 格式的文档
dokka:javadocJar	生成包含 Javadoc 格式文档的 javadoc.jar 文件

由于 Javadoc 输出格式是一个 Dokka 插件，您需要下载插件的 JAR 文件。

Javadoc 输出格式有两个依赖项，您需要以额外的 JAR 文件形式提供：

• kotlin-as-java 插件
• korte-jvm

通过命令行选项：

java -jar dokka-cli-2.1.0.jar \
     -pluginsClasspath "./dokka-base-2.1.0.jar;...;./javadoc-plugin-2.1.0.jar" \
     ...

通过JSON 配置：

{
  ...
  "pluginsClasspath": [
    "./dokka-base-2.1.0.jar",
    "...",
    "./kotlin-as-java-plugin-2.1.0.jar",
    "./korte-jvm-3.3.0.jar",
    "./javadoc-plugin-2.1.0.jar"
  ],
  ...
}

要了解更多信息，请参阅 CLI 运行程序文档中的其他输出格式。