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

Jeśli piszesz kod Compose do swojej aplikacji lub tworzysz biblioteki i interfejsy API Compose, stosuj się do sprawdzonych metod, aby zwiększyć skalowalność, wydajność i zgodność kodu z resztą ekosystemu.

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

  • Wytyczne dotyczące interfejsu API Jetpack Compose: zawiera wzorce, sprawdzone metody i wytyczne dotyczące stylu dla dowolnego systemu korzystającego z kompilatora Jetpack Compose i jego środowiska wykonawczego. Obejmuje ona te tematy:
    • Wytyczne 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
    • 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: zawiera zestaw wytycznych i zaleceń dotyczących tworzenia i używania komponentów interfejsu użytkownika @Composable, w tym te tematy:
    • Tworzenie i umieszczanie komponentów
    • Nazwa nowego komponentu
    • Wyrażenie zależności komponentów
    • Parametry w komponentach @Composable
    • Stosowanie prawidłowych wzoró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 jakimś fragmencie aplikacji.
  • Programiści pracujący nad platformą Jetpack Compose. Należysz do tej grupy, jeśli wnosisz swój wkład do bibliotek androidx.compose.
  • Programiści tworzący biblioteki na podstawie Jetpack Compose. Należysz do tej grupy, jeśli tworzysz interfejsy API lub biblioteki elementów interfejsu użytkownika Compose. Te biblioteki komponentów usługi Compose mogą być dostępne publicznie lub lokalnie w Twojej firmie lub zespole.

W zależności od grupy, do której należysz, masz różne poziomy rygoryzmu dla każdej wskazówki dotyczącej stylu. Na przykład rozwój platformy Jetpack Compose jest zazwyczaj najbardziej zgodny z tymi wskazówkami.

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

Współtworzenie ram i wytycznych

Zachęcamy do tworzenia wybranych bibliotek w kodzie źródłowym androidx oraz do tworzenia własnych wytycznych dotyczących stylu (wytycznych dotyczących interfejsu Compose API i wytycznych dotyczących komponentów @Composable).

Aby dodać treści, wykonaj instrukcje podane w przewodniku dotyczącym androidx.