Jetpack Compose API 的樣式指南

如果您正在為應用程式編寫 Compose 程式碼，或建構 Compose 程式庫和 API，請遵循最佳做法，確保程式碼可擴充、效能更佳，且與生態系統的其他部分保持一致。

下列文件提供使用 Compose 編寫程式碼的指南：

• Jetpack Compose 的 API 指南：針對使用 Jetpack Compose 編譯器外掛程式和執行階段的任何系統，概述模式、最佳做法和規範樣式指南。其中包含下列主題：
  • Compose 的 Kotlin 樣式指南，依據 Kotlin 編碼慣例
  • @Composable 函式和 API 的指南，這些函式和 API 是以 Compose 執行階段功能為基礎建構而成
  • 使用及擴充 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 貢獻指南中的指示操作。