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: omawiają wzorce, sprawdzone metody i wytyczne dotyczące stylu dla dowolnego systemu korzystającego z wtyczki kompilatora i czasu wykonywania Jetpack Compose. Obejmuje ona te tematy:
- Wytyczne dotyczące stylu Kotlina w Compose, oparte na konwencjach kodowania w Kotlinie
- Wskazówki dotyczące funkcji i interfejsów API
@Composable, które bazują na możliwościach ś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 dotyczące komponentów
@Composablew Jetpack Compose: Znajdziesz tu wskazówki i zalecenia dotyczące tworzenia i używania komponentów interfejsu@Composable. Znajdziesz w nim te tematy:- Tworzenie i umieszczanie komponentów
- Nazwa nowego komponentu
- Wyrażanie zależności komponentów
- Parametry w komponentach
@Composable - Zgodnie z prawidłowymi wzorcami tworzenia klas i funkcji powią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
Wskazówki te opracowaliśmy z myślą o tych 3 grupach odbiorców:
- Deweloperzy tworzący aplikacje w oparciu o 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 przekazujesz darowizny w ramach 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 wytycznymi.
Więcej informacji o wymaganiach dotyczących poszczególnych odbiorców dewelopera znajdziesz w RFC2119.
Współtworzenie ram i wytycznych
Zachęcamy do przekazywania darowizn do wybranych bibliotek w bazie kodu androidx oraz wytycznych dotyczących stylu (wytycznych dotyczących interfejsu Compose API i wytycznych dotyczących komponentów usługi @Composable).
Aby dodać treści, wykonaj instrukcje podane w przewodniku dotyczącym androidx.