Javadoc

Dokka 的 Javadoc 输出格式与 Java 的 Javadoc HTML 格式类似.

它试图在视觉效果上模仿由 Javadoc 工具生成的 HTML 页面, 但它不是 Javadoc 的直接实现, 也不是完全一样的复制.

所有的 Kotlin 代码和签名都会以 Java 的视角来显示. 这是通过我们的 Kotlin as Java Dokka plugin 来实现的, 这个 plugin 是 Dokka 默认附带的, 而且对这个格式会默认使用.

Javadoc 输出格式作为一个 Dokka plugin 来实现, 由 Dokka 开发组维护. 它是开源的, 源代码请参见 GitHub.

生成 Javadoc 文档

Gradle plugin for Dokka 包含了 Javadoc 输出格式. 你可以使用以下 task:

Task	描述
`dokkaJavadoc`	为单个项目生成 Javadoc 文档.
`dokkaJavadocCollector`	只为多项目构建中的父项目创建的 `Collector` task. 它会为每个子项目调用 `dokkaJavadoc`, 并将所有的输出合并到一个单独的虚拟项目.

javadoc.jar 文件可以单独生成. 详情请参见, 构建 javadoc.jar.

Maven plugin for Dokka 包含了 Javadoc 输出格式. 你可以使用以下 goal 生成文档:

Goal	描述
`dokka:javadoc`	生成 Javadoc 格式文档
`dokka:javadocJar`	生成 `javadoc.jar` 文件, 其中包含 Javadoc 格式文档

由于 Javadoc 输出格式是一个 Dokka plugin, 因此你需要下载 plugin 的 JAR 文件.

Javadoc 输出格式有 2 个依赖项, 你需要通过额外的 JAR 文件的方式提供:

通过命令行选项方式:

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

通过 JSON 配置方式:

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

更多详情, 请参见 CLI 运行器文档中的其他输出格式.

最终更新: 2024/11/17