Javadoc

最终更新: 2024/03/21

Javadoc 输出格式还处于 Alpha 状态, 因此你在使用时可能遇到 bug, 或迁移问题. 我们不保证能够与那些接受 Java 的 Javadoc HTML 格式作为输入的工具成功的集成. 使用这个功能时, 请自行承担风险.

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

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

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

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

生成 Javadoc 文档

Javadoc 格式不支持跨平台项目.

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

{
  ...
  "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"
  ],
  ...
}