Skip to content

Javadoc

DANGER

Javadoc 输出格式仍处于 Alpha 阶段,因此在使用时可能会发现错误并遇到迁移问题。

不保证与接受 Java Javadoc HTML 作为输入的工具成功集成。

您需自行承担使用风险。

Dokka 的 Javadoc 输出格式是 Java 的 Javadoc HTML 格式 的外观类似物。

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

Screenshot of javadoc output format

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

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

生成 Javadoc 文档

DANGER

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

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