Wytyczne dotyczące stylu dla interfejsów Jetpack Compose API

Jeśli piszesz kod Compose dla swojej aplikacji lub tworzysz biblioteki i interfejsy API Compose, postępuj zgodnie ze sprawdzonymi metodami, aby kod był skalowalny, wydajny i spójny z resztą ekosystemu.

Te dokumenty zawierają wskazówki dla każdego, kto pisze kod korzystający z Compose:

  • Wytyczne dotyczące interfejsu API dla Jetpack Compose: opisują wzorce, sprawdzone metody i wytyczne dotyczące stylu dla każdego systemu korzystającego z wtyczki kompilatora i środowiska wykonawczego Jetpack Compose. Obejmuje on te tematy:
    • Wytyczne dotyczące stylu języka Kotlin w Compose na podstawie konwencji kodowania w języku Kotlin.
    • Wskazówki dotyczące funkcji i interfejsów API @Composable, które wykorzystują możliwości środowiska wykonawczego Compose
    • Wytyczne dotyczące interfejsów API, które używają i rozszerzają zestaw narzędzi interfejsu Compose
    • Wzorce rozwiązywania problemów podczas projektowania interfejsu API Compose
  • Wytyczne dotyczące interfejsu API dla komponentów @Composable w Jetpack Compose: zawierają zestaw wytycznych i rekomendacji dotyczących tworzenia i używania komponentów interfejsu @Composable, w tym te tematy:
    • Tworzenie i nakładanie komponentów
    • Nazwanie nowego komponentu
    • wyrażanie zależności komponentów,
    • Parametry w komponentach @Composable
    • stosowanie prawidłowych wzorców tworzenia klas i funkcji związanych z komponentami;
    • Dokumentowanie komponentów @Composable
    • Ulepszanie ułatwień dostępu do komponentów
    • aktualizowanie interfejsów API komponentów przy zachowaniu zgodności wstecznej;

Odbiorcy

Te wytyczne są przeznaczone dla 3 grup odbiorców:

  • Deweloperzy tworzący aplikacje na podstawie Jetpack Compose. Należysz do tej grupy, jeśli używasz Jetpack Compose w niektórych częściach aplikacji.
  • Deweloperzy pracujący nad rozwojem platformy Jetpack Compose. Należysz do tej grupy, jeśli współtworzysz biblioteki androidx.compose.
  • Deweloperzy tworzący biblioteki na podstawie Jetpack Compose Należysz do tej grupy, jeśli tworzysz interfejsy API Compose lub biblioteki elementów interfejsu Compose. Te biblioteki komponentów Compose mogą być dostępne publicznie lub lokalnie dla Twojej firmy lub zespołu.

W zależności od grupy, do której należysz, masz różne poziomy rygorystyczności dla każdej wytycznej dotyczącej stylu. Na przykład te wytyczne są najściślej przestrzegane podczas tworzenia platformy Jetpack Compose.

Więcej informacji o wymaganiach dotyczących poszczególnych grup deweloperów znajdziesz w dokumencie RFC2119.

Wkład w opracowanie ram i wytycznych

Zachęcamy do współtworzenia wybranych bibliotek w bazie kodu androidx oraz samych wytycznych dotyczących stylu (wytyczne dotyczące interfejsu Compose API i wytyczne dotyczące komponentów @Composable).

Aby przesłać treści, postępuj zgodnie z instrukcjami podanymi w androidx przewodniku.