Если вы пишете код Compose для своего приложения или создаете библиотеки и API Compose, следуйте передовым практикам, чтобы сделать свой код масштабируемым, более производительным и согласованным с остальной частью экосистемы.
Следующие документы содержат рекомендации для тех, кто пишет код, использующий Compose:
- API Guidelines for Jetpack Compose : описывает шаблоны, лучшие практики и предписывающие руководства по стилю для любой системы, использующей плагин компилятора Jetpack Compose и среду выполнения. Включает следующие темы:
- Руководящие принципы стиля Kotlin для Compose, основанные на соглашениях о кодировании Kotlin
- Руководство по функциям
@Composableи API, которые основаны на возможностях среды выполнения Compose - Рекомендации для API, которые используют и расширяют набор инструментов Compose UI
- Шаблоны для рассмотрения вариантов использования при проектировании API Compose
- Руководство по API для компонентов
@Composableв Jetpack Compose : предоставляет набор руководств и рекомендаций по созданию и использованию компонентов пользовательского интерфейса@Composable, включая следующие темы:- Создание и наложение компонентов
- Наименование нового компонента
- Выражение зависимостей компонентов
- Параметры в компонентах
@Composable - Следование правильным шаблонам создания классов и функций, связанных с компонентами
- Документирование компонентов
@Composable - Улучшение доступности компонентов
- Обновление API компонентов с сохранением обратной совместимости
Аудитория
Эти рекомендации написаны для следующих трех аудиторий:
- Разработчики, создающие приложения на основе Jetpack Compose . Вы находитесь в этой группе, если используете Jetpack Compose в какой-то части своего приложения.
- Разработчики, работающие над разработкой фреймворка Jetpack Compose . Вы в этой группе, если вносите вклад в библиотеки
androidx.compose. - Разработчики, создающие библиотеки на основе Jetpack Compose . Вы находитесь в этой группе, если создаете API Compose или библиотеки элементов пользовательского интерфейса Compose. Эти библиотеки компонентов Compose могут быть общедоступными или локальными для вашей компании или команды.
В зависимости от группы, в которой вы находитесь, у вас есть разные уровни строгости для каждого руководства по стилю. Например, разработка фреймворка Jetpack Compose обычно придерживается наиболее строго этих руководств.
Более подробную информацию о требованиях для каждой аудитории разработчиков см. в RFC2119 .
Внести вклад в структуру и руководящие принципы
Мы приветствуем вклад в отдельные библиотеки в кодовой базе androidx , а также в сами руководства по стилю ( руководства по Compose API и руководства по компонентам @Composable ).
Чтобы внести свой вклад, следуйте инструкциям в руководстве по внесению вклада в androidx .