如果您要为应用编写 Compose 代码或构建 Compose 库, API,遵循最佳实践提高代码的可伸缩性、性能和 与生态系统的其他方面保持一致。
以下文档为编写使用 撰写:
- Jetpack Compose 的 API 指南:概述模式,最佳
做法和规范性样式指南,适用于使用 Jetpack 的任何系统
Compose 编译器插件和运行时。其中包括以下主题:
<ph type="x-smartling-placeholder">
- </ph>
- Compose 的 Kotlin 样式指南(基于 Kotlin 编码) 惯例
- 有关基于 Compose 构建的
@Composable
函数和 API 的指南 运行时功能 - 使用和扩展 Compose 界面工具包的 API 指南
- 设计 Compose API 时处理用例的模式
- Jetpack Compose 中
@Composable
组件的 API 指南: 提供有关创建和使用@Composable
界面组件,包括以下主题:- 创建组件和叠加组件
- 为新组件命名
- 表示组件依赖关系
@Composable
组件中的参数- 遵循创建与组件相关的类以及 函数
- 记录
@Composable
组件 - 改进组件的无障碍功能
- 更新组件 API,同时保持向后兼容性
受众群体
这些指南针对以下三类受众编写:
- 基于 Jetpack Compose 构建应用的开发者。您在该群组中 。
- 从事 Jetpack Compose 框架开发的开发者。您目前位于
如果您为
androidx.compose
库做出贡献,则可以访问该组。 - 开发者基于 Jetpack Compose 创建库。您在此 群组。这些 Compose 组件库可能是公开提供的,也可能是 共享内容。
根据您所在的群组,您为每个群组设置了不同的严格程度 样式指南。例如,Jetpack Compose 框架开发 。
如需详细了解面向各开发者群体的要求,请参阅 RFC2119。
为框架和准则做出贡献
我们欢迎开发者在 androidx
代码库和
样式指南(Compose API 指南和
@Composable
组件指南)。
若要做出贡献,请按照androidx
贡献内容中的说明进行操作
指南。