简介

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

就像 Kotlin 本身一样，Dokka 也支持混合语言项目。它能够理解 Kotlin 的 KDoc 注释和 Java 的 Javadoc 注释。

Dokka 可以生成多种格式的文档，包括其现代化的 HTML 格式、Java 的 Javadoc HTML，以及 GFM 和 Jekyll 风格的 Markdown。

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

• kotlinx.coroutines
• Bitmovin
• Hexagon
• Ktor
• OkHttp

您可以使用 Gradle、Maven 或通过命令行运行 Dokka。它还具有高度可插拔性。

请参阅 Dokka 使用入门开始您的 Dokka 之旅。

社区

Dokka 在 Kotlin 社区 Slack 中设有专门的 #dokka 频道，您可以在那里讨论 Dokka 及其插件以及如何开发它们，并与维护者取得联系。