News

Dokka 开始测试啦 – 快来试试并分享您的反馈!

Read this post in other languages:
English

我们很高兴地宣布,Dokka 已经进入了测试阶段。 这意味着我们距离稳定版发布越来越近,但在此之前,我们需要您对测试版中的主要新功能 – 新的 HTML 输出格式的反馈。

包的示例

这次测试版本的发布主要是为了完善 HTML 输出格式的 UI 和 UX,以便它们满足社区的要求,并在下一个版本 1.7 中及时实现它们。 请尝试一下 1.6 版本,并分享您的反馈以及您的使用案例。 您可以在 Slack 上的 Dokka 频道提交反馈,也可以通过我们的bug跟踪系统创建工单来提交反馈。 如果您还不是 Kotlin Slack 的成员,可以请求加入

什么是 Dokka?

DDokka 是一个 Gradle/Maven 插件,它收集以 KDoc 或 JavaDoc 格式编写的代码文档,并生成 HTML,GitHub Flavored Markdown (GFM) 和 Jekyll 输出,以便与产品的用户和协作者共享。 这样的输出可以内部或者公开使用,可以交付给版本控制系统以供离线访问,也可以根据您的需求进行配置。

如何应用插件

查看更多有关配置 Dokka 的详细信息。

稳定版的发布计划

在即将发布的稳定版中,我们计划:

  • 根据用户反馈稳定 HTML 输出。
  • 在 Kotlin Gradle 插件中包含 Dokka,以便默认情况下可用。
  • 修复了大型项目的内存不足的问题 。

当前稳定版本不包括其他的输出格式 (与 HTML 不同),插件开发的 API 以及对 Java 的完全支持。 为了推进这些功能并确定它们的工作优先级,我们将对用户进行一系列的访谈。 如果您有兴趣参加访谈帮助塑造 Dokka 的未来,请通过 Dokka 的 Slack 频道与我们联系。

更多 Dokka 使用的文档示例

接口示例

函数示例

其他资源 

  1. Kotlin 官方网站上 Dokka 的概述。 
  2. Dokka 的 GitHub 主页 和 GitHub 上的详细文档
  3. 有关 Dokka Alpha 版本和 Dokka 预览版的博客文章。

英文博文原作者:

Lei

Eugene Rubilov

特别感谢由来自 Kotlin 社区的 skaifun 为本篇博文提供中文译文。

Discover more