Javadoc

Javadoc 输出格式仍处于 Alpha 阶段，因此在使用时可能会发现 bug 并遇到迁移问题。 无法保证与接受 Java 的 Javadoc HTML 作为输入的工具成功集成。 请自行承担使用风险。

Dokka 的 Javadoc 输出格式类似于 Java 的 Javadoc HTML 格式。

它试图在视觉上模仿 Javadoc 工具生成的 HTML 页面，但它不是直接实现，也不是精确副本。

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

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

生成 Javadoc 文档

Javadoc 格式不支持多平台项目。

GradleMavenCLI

Dokka 的 Gradle 插件 包含了 Javadoc 输出格式。你可以使用以下任务：

任务	描述
dokkaJavadoc	为单个项目生成 Javadoc 文档。
dokkaJavadocCollector	一个 Collector 任务，仅为多项目构建中的父项目创建。它会为每个子项目调用 dokkaJavadoc 并将所有输出合并到一个单个虚拟项目。

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

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

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

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

Javadoc 输出格式有两个依赖项，你需要将其作为附加 JAR 文件提供：

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

通过 命令行选项：

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

通过 JSON 配置：

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

更多信息，请参见 CLI 运行器文档中的 其他输出格式。