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

Jeśli piszesz kod tworzenia wiadomości dla aplikacji lub tworzysz biblioteki i interfejsy API tej funkcji, postępuj zgodnie ze sprawdzonymi metodami, aby Twój kod był skalowalny, wydajny i spójny z resztą ekosystemu.

Te dokumenty zawierają wskazówki dla wszystkich osób, które piszą kod korzystający z funkcji tworzenia wiadomości:

  • Wskazówki dotyczące interfejsu API dla Jetpack Compose: schematy, sprawdzone metody i wytyczne dotyczące stylu dla każdego systemu korzystającego z wtyczki kompilatora Jetpack Compose i środowiska wykonawczego. Obejmuje ona takie tematy:
    • Wskazówki dotyczące stylu Kotlin dotyczące tworzenia wiadomości, zgodne z konwencjami kodowania Kotlin
    • Wskazówki dotyczące funkcji i interfejsów API @Composable, które bazują na funkcjach środowiska wykonawczego tworzenia
    • Wskazówki dotyczące interfejsów API, które korzystają z narzędzi interfejsu użytkownika tworzenia wiadomości i które je rozszerzają
    • Wzorce obsługi przypadków użycia podczas projektowania interfejsu Compose API
  • Wskazówki dotyczące interfejsu API dotyczące komponentów @Composable w Jetpack Compose: zestaw wytycznych i zaleceń dotyczących tworzenia i używania komponentów interfejsu @Composable, w tym tych tematów:
    • Tworzenie komponentów i nakładanie warstw
    • nazewnictwo nowego komponentu,
    • Wyrażanie zależności komponentów
    • Parametry w @Composable komponentach
    • Tworzenie klas i funkcji powiązanych z komponentami z właściwymi wzorcami
    • Dokumentuję @Composable komponentów
    • Poprawa ułatwień dostępu do komponentów
    • Aktualizowanie interfejsów API komponentów przy zachowaniu zgodności wstecznej

Odbiorcy

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

  • Programiści tworzący aplikacje na podstawie Jetpack Compose Należysz do tej grupy, jeśli używasz Jetpack Compose w jakiejś części aplikacji.
  • Programiści pracujący nad platformą Jetpack Compose. Należysz do tej grupy, jeśli publikujesz treści w bibliotece androidx.compose.
  • Deweloperzy tworzący biblioteki na podstawie Jetpack Compose Należysz do tej grupy, jeśli tworzysz interfejsy API interfejsu Compose lub biblioteki elementów tego interfejsu. Te biblioteki komponentów tworzenia wiadomości mogą być dostępne publicznie lub lokalnie dla Twojej firmy lub zespołu.

W zależności od grupy, do której należysz, każdy z wytycznych dotyczących stylu ma różne poziomy rygorystyczności. Przykładowo, środowisko programistyczne Jetpack Compose jest w większości zgodne z tymi wytycznymi.

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

Publikuj treści w ramach zasad i wytycznych

Zachęcamy do przesyłania treści do wybranych bibliotek w bazie kodu androidx oraz wytycznych dotyczących stylu (wytycznych dotyczących interfejsu Compose API i wytycznych dotyczących komponentów @Composable).

Aby opublikować treści, postępuj zgodnie z instrukcjami podanymi w przewodniku po publikacji treści w usłudze androidx.