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

Jeśli piszesz kod Compose dla aplikacji lub tworzysz biblioteki i interfejsy API Compose, stosuj sprawdzone metody, aby Twój kod był skalowalny, wydajniejszy i spójny z pozostałą częścią ekosystemu.

Poniższe dokumenty zawierają wskazówki dla osób piszących kod, który korzysta z Compose:

  • Wytyczne dotyczące interfejsu API w Jetpack Compose: opisują wzorce, sprawdzone metody i wytyczne dotyczące stylu w przypadku każdego systemu korzystającego z wtyczki kompilatora i środowiska wykonawczego Jetpack Compose. Obejmuje ona te tematy:
    • Wytyczne dotyczące stylu w Kotlinie w przypadku Compose, oparte na konwencjach kodowania w Kotlinie
    • Wskazówki dotyczące funkcji i interfejsów API @Composable, które korzystają z możliwości środowiska wykonawczego Compose
    • Wytyczne dotyczące interfejsów API, które korzystają z zestawu narzędzi interfejsu Compose i go rozszerzają
    • Wzorce rozwiązywania przypadków użycia podczas projektowania interfejsu Compose API
  • 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 następujące tematy:
    • Tworzenie i warstwowanie komponentów
    • Nadawanie nazwy nowemu komponentowi
    • Określanie 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 oparte na Jetpack Compose Należysz do tej grupy, jeśli używasz Jetpack Compose w części aplikacji.
  • Deweloperzy pracujący nad platformą Jetpack Compose. Należysz do tej grupy, jeśli przesyłasz treści do androidx.composebibliotek.
  • Tworzenie bibliotek opartych na 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ć publicznie dostępne lub lokalne dla Twojej firmy lub zespołu.

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

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

Współtworzenie platformy i wytycznych

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

Aby wziąć udział w tym programie, postępuj zgodnie z instrukcjami w androidx przewodniku.