Jetpack Compose API 的樣式指南

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

下列文件提供指南，供所有使用 Compose 編寫程式碼的使用者參考：

• Jetpack Compose 的 API 指南：針對使用 Jetpack Compose 編譯器外掛程式和執行階段的任何系統，概述模式、最佳做法和規範式樣式指南。其中涵蓋的主題包括：
  • 根據 Kotlin 程式碼編寫慣例，提供 Compose 適用的 Kotlin 樣式指南
  • 針對 @Composable 函式和 Compose 執行階段功能所建構的 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 貢獻指南中的指示操作。