Wenn Sie Compose-Code für Ihre Anwendung oder Compose-Bibliotheken und -APIs erstellen, befolgen Sie die Best Practices, um Ihren Code skalierbarer, leistungsfähiger und einheitlicher zu machen.
Die folgenden Dokumente enthalten Richtlinien für alle, die Code schreiben, der Composer verwendet:
- API-Richtlinien für Jetpack Compose: Beschreibt Muster, Best Practices und vorgeschriebene Stilrichtlinien für jedes System, das das Jetpack Compose-Compiler-Plug-in und die Jetpack Compose-Laufzeit verwendet. Folgende Themen werden behandelt:
- Kotlin-Stilrichtlinien für Compose basierend auf den Kotlin-Coding-Conventions
- Anleitung für
@Composable-Funktionen und APIs, die auf den Compose-Laufzeitfunktionen aufbauen - Richtlinien für APIs, die das Toolkit „Compose UI“ verwenden und erweitern
- Muster für Anwendungsfälle beim Entwerfen einer Compose API
- API-Richtlinien für
@Composable-Komponenten in Jetpack Compose: Bietet eine Reihe von Richtlinien und Empfehlungen zum Erstellen und Verwenden von@Composable-UI-Komponenten, einschließlich der folgenden Themen:- Komponenten erstellen und übereinanderlegen
- Neue Komponente benennen
- Komponentenabhängigkeiten ausdrücken
- Parameter in
@Composable-Komponenten - Beim Erstellen von komponentenbezogenen Klassen und Funktionen die richtigen Muster beachten
@Composable-Komponenten dokumentieren- Verbesserte Barrierefreiheit von Komponenten
- Aktualisieren der Komponenten-APIs unter Beibehaltung der Abwärtskompatibilität
Zielgruppe
Diese Richtlinien richten sich an die folgenden drei Zielgruppen:
- Entwickler, die Anwendungen basierend auf Jetpack Compose erstellen Sie befinden sich in dieser Gruppe, wenn Sie Jetpack Compose in einem Teil Ihrer Anwendung verwenden.
- Entwickler, die an der Entwicklung des Jetpack Compose-Frameworks arbeiten Sie gehören zu dieser Gruppe, wenn Sie an den
androidx.compose-Bibliotheken mitwirken. - Entwickler, die Bibliotheken basierend auf Jetpack Compose erstellen Sie befinden sich in dieser Gruppe, wenn Sie Compose APIs oder Bibliotheken mit Compose-UI-Elementen erstellen. Diese Bibliotheken von Compose-Komponenten können öffentlich oder lokal für Ihr Unternehmen oder Team verfügbar sein.
Abhängig von der Gruppe, der Sie angehören, gibt es für jede Stilrichtlinie unterschiedliche strikte Stufen. Die Entwicklung des Jetpack Compose-Frameworks hält sich beispielsweise am strengsten an diese Richtlinien.
Weitere Informationen zu den Anforderungen für die einzelnen Entwicklerzielgruppen finden Sie unter RFC2119.
Zum Framework und zu Richtlinien beitragen
Wir freuen uns über Beiträge zu ausgewählten Bibliotheken in der androidx-Codebasis und in den Stilrichtlinien (Compose API-Richtlinien und Richtlinien für @Composable-Komponenten) selbst.
Wenn du beitragen möchtest, folge der Anleitung im androidx Leitfaden zu Beiträgen.