如果您要为应用编写 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 贡献
指南中的说明操作。