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 贡献指南 中的说明进行操作。