如要編寫應用程式的 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
捐款指南中的指示操作。