如果您在为应用编写 Compose 代码或构建 Compose 库和 API,请遵循最佳实践,让您的代码具有可伸缩性、性能更佳且与生态系统的其余部分更加一致。
以下文档为使用 Compose 编写代码的所有人员提供了指南:
- Jetpack Compose 的 API 准则:概述了适用于使用 Jetpack Compose 编译器插件和运行时的任何系统的模式、最佳实践和规范性样式准则。其中包含以下主题:
- 基于 Kotlin 编码规范的 Compose 的 Kotlin 样式准则
- 有关基于 Compose 运行时功能构建的
@Composable
函数和 API 的指南 - 有关使用和扩展 Compose 界面工具包的 API 的准则
- 在设计 Compose API 时处理用例的模式
- 针对 Jetpack Compose 中
@Composable
组件的 API 准则:提供了关于创建和使用@Composable
界面组件的一系列准则和建议,其中包括以下主题:- 创建组件和分层组件
- 为新组件命名
- 表示组件依赖关系
@Composable
组件中的参数- 遵循正确的模式来创建与组件相关的类和函数
- 记录
@Composable
组件 - 改进组件的无障碍功能
- 更新了组件 API,同时保持向后兼容性
观众
这些指南主要面向以下三种受众:
- 基于 Jetpack Compose 构建应用的开发者。如果您在应用的某些部分使用 Jetpack Compose,则属于该组。
- 从事 Jetpack Compose 框架开发的开发者。如果您为
androidx.compose
库做贡献,便可以成为此成员。 - 基于 Jetpack Compose 创建库的开发者。如果您创建 Compose API 或 Compose 界面元素库,则属于此组。这些 Compose 组件库可能是公开发布的,也可能是您的公司或团队的本地资源。
每条样式准则的严格程度会因您所在的小组而异。例如,Jetpack Compose 框架开发通常最严格地遵循这些准则。
如需详细了解针对各开发者受众群体的要求,请参阅 RFC2119。
为框架和指南做贡献
我们欢迎开发者为 androidx
代码库和样式准则(Compose API 准则和 @Composable
组件准则)本身中的部分库贡献代码。
如需贡献内容,请按照 androidx
贡献指南中的说明操作。