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

Jeśli piszesz kod Compose na potrzeby swojej aplikacji lub tworzysz biblioteki i interfejsy API Compose, stosuj sprawdzone metody, aby Twój kod był skalowalny, wydajniejszy i zgodny z resztą ekosystemu.

Te dokumenty zawierają wskazówki dla wszystkich, którzy piszą kod korzystający z Compose:

  • Wskazówki dotyczące interfejsów API Jetpack Compose: opisują wzorce, sprawdzone metody i zalecane wytyczne dotyczące stylu dla każdego systemu korzystającego z wtyczki kompilatora i środowiska wykonawczego Jetpack Compose. Obejmują one te tematy:
    • Wskazówki dotyczące stylu Kotlina w Compose, oparte na konwencjach kodowania w Kotlinie
    • Wskazówki dotyczące funkcji @Composable i interfejsów API, które korzystają z możliwości środowiska wykonawczego Compose
    • Wskazówki dotyczące interfejsów API, które korzystają z narzędzia Compose UI i je rozszerzają
    • Wzorce rozwiązywania przypadków użycia podczas projektowania interfejsu API Compose
  • Wskazówki dotyczące interfejsów API dla komponentów @Composable w Jetpack Compose: zawierają zestaw wskazówek i zaleceń dotyczących tworzenia i używania @Composable komponentów interfejsu, w tym te 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 wskazówki są przeznaczone dla 3 grup odbiorców:

  • Deweloperzy tworzący aplikacje oparte na Jetpack Compose. Jeśli używasz Jetpack Compose w jakiejś części swojej aplikacji, należysz do tej grupy.
  • Deweloperzy pracujący nad rozwojem platformy Jetpack Compose. Jeśli współtworzysz biblioteki androidx.compose, należysz do tej grupy.
  • Deweloperzy tworzący biblioteki oparte na Jetpack Compose. Jeśli tworzysz interfejsy API Compose lub biblioteki elementów interfejsu Compose, należysz do tej grupy. 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 w przypadku każdej wskazówki dotyczącej stylu. Na przykład rozwój platformy Jetpack Compose na ogół najbardziej rygorystycznie przestrzega tych wskazówek.

Więcej informacji o wymaganiach dotyczących każdej grupy deweloperów znajdziesz w dokumencie RFC2119.

Współtworzenie platformy i wskazówek

Zachęcamy do współtworzenia wybranych bibliotek w bazie kodu androidx oraz samych wskazówek dotyczących stylu (wskazówek dotyczących interfejsów API Compose oraz @Composable wskazówek dotyczących komponentów).

Aby współtworzyć, postępuj zgodnie z instrukcjami w androidx przewodniku współtworzenia.