Wenn Sie Compose-Code für Ihre App schreiben oder Compose-Bibliotheken und APIs erstellen, sollten Sie Best Practices befolgen, damit Ihr Code skalierbar, leistungsfähiger und mit dem Rest des Ökosystems kompatibel ist.
Die folgenden Dokumente enthalten Richtlinien für alle, die Code schreiben, in dem Compose verwendet wird:
- API-Richtlinien für Jetpack Compose: Hier werden Muster, Best Practices und verbindliche Stilrichtlinien für jedes System beschrieben, das das Jetpack Compose-Compiler-Plug-in und die Laufzeit verwendet. Dazu gehören die folgenden Themen:
- Kotlin-Stilrichtlinien für Compose, basierend auf den Kotlin-Programmierkonventionen
- Anleitung für
@Composable-Funktionen und APIs, die auf den Compose-Laufzeitfunktionen basieren - Richtlinien für APIs, die das Compose-UI-Toolkit verwenden und erweitern
- Muster für die Behandlung von Anwendungsfällen beim Entwerfen einer Compose API
- API-Richtlinien für
@Composable-Komponenten in Jetpack Compose: Hier finden Sie eine Reihe von Richtlinien und Empfehlungen für die Erstellung und Verwendung von@Composable-UI-Komponenten, einschließlich der folgenden Themen:- Komponenten erstellen und übereinanderlegen
- Neue Komponente benennen
- Komponentenabhängigkeiten angeben
- Parameter in
@Composable-Komponenten - Befolgen Sie die richtigen Muster zum Erstellen von komponentenbezogenen Klassen und Funktionen.
@Composable-Komponenten dokumentieren- Bedienungshilfen für Komponenten verbessern
- Komponenten-APIs aktualisieren und gleichzeitig die Abwärtskompatibilität beibehalten
Zielgruppe
Diese Richtlinien richten sich an folgende drei Zielgruppen:
- Entwickler, die Apps auf Grundlage von Jetpack Compose erstellen Sie gehören zu dieser Gruppe, wenn Sie Jetpack Compose in einem Teil Ihrer App verwenden.
- Entwickler, die am Jetpack Compose-Framework arbeiten Sie sind in dieser Gruppe, wenn Sie Beiträge zu den
androidx.compose-Bibliotheken leisten. - Entwickler, die Bibliotheken auf Basis von Jetpack Compose erstellen Sie gehören zu dieser Gruppe, wenn Sie Compose-APIs oder Bibliotheken von Compose-UI-Elementen erstellen. Diese Bibliotheken mit Compose-Komponenten können öffentlich verfügbar oder lokal für Ihr Unternehmen oder Team sein.
Je nach Gruppe, der Sie angehören, gelten für jede Stilrichtlinie unterschiedliche Strengegrade. Die Entwicklung des Jetpack Compose-Frameworks hält sich beispielsweise in der Regel am strengsten an diese Richtlinien.
Weitere Informationen zu den Anforderungen für die einzelnen Entwicklerzielgruppen finden Sie unter RFC2119.
Beiträge zu Framework und Richtlinien leisten
Wir freuen uns über Beiträge zu ausgewählten Bibliotheken im androidx-Code und zu den Stilrichtlinien (Compose API-Richtlinien und @Composable-Komponentenrichtlinien).
Wenn Sie Inhalte beitragen möchten, folgen Sie der Anleitung im androidx Leitfaden für Beiträge.