我们正在改进库作者体验!

Read this post in other languages:

现代编程语言生态系统包括从测试框架到机器学习库再到 Web 开发框架的一切。 这些选项通常由库作者提供给社区。

Kotlin 团队明白,作者的工作对所有用户都相当重要。 因此,我们希望通过工具和文档来提供支持。 库作者体验是 2023 年 Kotlin 路线图的一大首要优先事项

在这篇博文中,我们将进一步介绍我们的计划和已经完成的工作,特别是 Dokka 文档更新。

改进库作者体验

我们专注于改进记录公共 API 的主要痛点,帮助库作者进行 API 设计,并提供方便的开发环境设置,包括项目模板和 CI 脚本。 详细了解我们的计划,随时在 YouTrack 的专用工单中参与讨论。

KDoc 体验改进 KT-55073

  • 改进 KDoc 和多行注释的格式。
  • 在 KDoc 注释中支持指向特定重载的链接。
  • 在 KDoc 注释中支持示例代码的高亮显示和建议。
  • 在显式 API 模式开启时,为公共 API 提供针对缺失 KDoc 注释的检查。

Dokka 稳定版本。 KT-48998

  • 使用 HTML 输出稳定 Dokka。
  • 发布完全修改的 Dokka 文档。

面向库作者的 Kotlin API 指南。 KT-55077

  • 为库作者提供全面的 API 指南。
  • 描述 JVM 和多平台库开发的最佳做法。
  • 列出有助于库开发(包括项目设置、确保向后兼容和发布)的工具。

隆重推出新的 Dokka 文档!

查看经过重写的、更加人性化的 Dokka 文档,并告诉我们您的想法。 

我们为 Gradle 项目配置添加了 Groovy DSL 示例,为 Maven 项目添加了示例。 这将帮助使用这些脚本和构建工具的开发者。

我们还重新组织了页面结构,添加了更多配置示例,并提供了配置选项描述来帮助新手更快入门。

要详细了解有关针对库作者的计划改进和其他 Kotlin 计划,请查看 Kotlin 路线图

另请参阅

本博文英文原作者:

Sue

Denis Ambatenne

image description

Discover more