Jetpack Compose API 样式指南

如果您正在为应用编写 Compose 代码或构建 Compose 库和 API，请遵循最佳实践，以使您的代码具有可伸缩性、更高性能并与生态系统的其余部分保持一致。

以下文档提供了有关编写使用 Compose 的任何代码的指南：

• Jetpack Compose 的 API 指南：概述了任何使用 Jetpack Compose 编译器插件和运行时的系统所需的模式、最佳实践和规范性样式指南。它包括以下主题：
  • 基于Kotlin 编码规范的 Compose 版 Kotlin 样式指南
  • 关于基于 Compose 运行时功能构建的 @Composable 函数和 API 的指导
  • 关于使用和扩展 Compose UI 工具包的 API 的指南
  • 在设计 Compose API 时解决用例的模式
• Jetpack Compose 中 @Composable 组件的 API 指南：提供了一组用于创建和使用 @Composable UI 组件的指南和建议，包括以下主题：
  • 创建和分层组件
  • 命名新组件
  • 表达组件依赖关系
  • @Composable 组件中的参数
  • 遵循创建组件相关类和函数的正确模式
  • 文档化 @Composable 组件
  • 提高组件的无障碍功能
  • 更新组件 API 同时保留向后兼容性

受众群体

这些指南是为以下三类受众编写的：

• 基于 Jetpack Compose 构建应用的开发者。如果您的应用在某些部分使用了 Jetpack Compose，您就属于此类别。
• 从事 Jetpack Compose 框架开发的开发者。如果您对 androidx.compose 库有所贡献，您就属于此类别。
• 创建基于 Jetpack Compose 的库的开发者。如果您创建 Compose API 或 Compose UI 元素库，您就属于此类别。这些 Compose 组件库可以是公开的，也可以是公司或团队内部使用的。

根据您所属的组别，每个样式指南都有不同的严格级别。例如，Jetpack Compose 框架开发通常最严格地遵守这些指南。

有关每个开发者受众群体要求的更多信息，请参阅 RFC2119。

为框架和指南做贡献

我们欢迎对 androidx 代码库中的精选库以及样式指南（Compose API 指南和 @Composable 组件指南）本身做出贡献。

要贡献代码，请按照 androidx 贡献指南中的说明进行操作。