Wenn Sie Compose-Code für Ihre App schreiben oder Compose-Bibliotheken und ‑APIs erstellen, sollten Sie die Best Practices befolgen, um Ihren Code skalierbar, leistungsfähiger und mit dem Rest des Systems kompatibel zu machen.
Die folgenden Dokumente enthalten Richtlinien für alle, die Code mit Compose schreiben:
- API-Richtlinien für Jetpack Compose: Hier werden Muster, Best Practices und präskriptive Stilrichtlinien für jedes System beschrieben, das das Jetpack Composer-Compiler-Plug-in und die -Laufzeit verwendet. Sie umfasst die folgenden Themen:
- Kotlin-Stilrichtlinien für Compose basierend auf den Kotlin-Coding-Konventionen
- Anleitungen für
@Composable-Funktionen und APIs, die auf den Compose-Laufzeitfunktionen aufbauen - Richtlinien für APIs, die das Compose-UI-Toolkit verwenden und erweitern
- Muster für die Adressierung von Anwendungsfällen beim Entwerfen einer Compose API
- API-Richtlinien für
@Composable-Komponenten in Jetpack Compose: Enthält eine Reihe von Richtlinien und Empfehlungen zum Erstellen und Verwenden von@Composable-UI-Komponenten, darunter die folgenden Themen:- Komponenten erstellen und überlagern
- Neue Komponente benennen
- Komponentenabhängigkeiten ausdrücken
- Parameter in
@Composable-Komponenten - Die richtigen Muster für die Erstellung komponentenbezogener Klassen und Funktionen befolgen
@Composable-Komponenten dokumentieren- Bedienungshilfen für Komponenten verbessern
- Komponenten-APIs aktualisieren und gleichzeitig die Abwärtskompatibilität beibehalten
Zielgruppe
Diese Richtlinien richten sich an die folgenden drei Zielgruppen:
- Entwickler, die Apps auf der Grundlage von Jetpack Compose erstellen Sie gehören zu dieser Gruppe, wenn Sie Jetpack Compose in einem Teil Ihrer App verwenden.
- Entwickler, die an der Entwicklung des Jetpack Compose-Frameworks arbeiten Sie sind in dieser Gruppe, wenn Sie Beiträge zu den
androidx.compose-Bibliotheken leisten. - Entwickler, die auf Jetpack Compose basierende Bibliotheken erstellen Sie sind in dieser Gruppe, wenn Sie Compose APIs oder Bibliotheken mit Compose-UI-Elementen erstellen. Diese Bibliotheken mit Compose-Komponenten können öffentlich oder lokal für Ihr Unternehmen oder Team verfügbar sein.
Je nach Gruppe, in der Sie sich befinden, gelten für jede Stilrichtlinie unterschiedliche Strengegrade. Bei der Entwicklung des Jetpack Compose-Frameworks werden diese Richtlinien beispielsweise am strengsten eingehalten.
Weitere Informationen zu den Anforderungen für die einzelnen Entwicklergruppen finden Sie unter RFC2119.
Zum Framework und den Richtlinien beitragen
Wir freuen uns über Beiträge zu ausgewählten Bibliotheken in der androidx-Codebasis und zu den Stilrichtlinien (Compose API-Richtlinien und @Composable-Komponentenrichtlinien).
Folgen Sie der Anleitung im androidx Leitfaden für Beiträge, um Beiträge zu leisten.