Skip to content

简介

Dokka 是一个用于 Kotlin 的 API 文档引擎。

如同 Kotlin 本身一样,Dokka 支持混合语言项目。它能理解 Kotlin 的 KDoc 注释和 Java 的 Javadoc 注释

Dokka 可以生成多种格式的文档,包括其现代 HTML 格式、多种风格的 Markdown,以及 Java 的 Javadoc HTML

以下是一些使用 Dokka 生成其 API 参考文档的库:

你可以使用 GradleMaven 或从命令行运行 Dokka。它也高度可插拔

关于使用 Dokka 的第一步,请参见 Dokka 入门指南

社区

Dokka 在 Kotlin 社区 Slack 中有一个专门的 #dokka 频道,你可以在其中讨论 Dokka、其插件以及如何开发它们,并与维护者取得联系。