Jetpack Compose API 的樣式指南

如果您要為應用程式編寫 Compose 程式碼,或是建構 Compose 程式庫和 API,請遵循最佳做法,讓程式碼可擴充、效能更高,並與生態系統的其餘部分保持一致。

下列文件提供指南,適用於所有使用 Compose 編寫程式碼的人員:

  • Jetpack Compose 的 API 指南:針對使用 Jetpack Compose 編譯器外掛程式和執行階段的任何系統,說明模式、最佳做法和規範性樣式指南。內容涵蓋下列主題:
    • Compose 適用的 Kotlin 樣式指南,以 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 貢獻指南中的指示操作。