Рекомендации по стилю для API Jetpack Compose

Если вы пишете код для Compose для своего приложения или создаёте библиотеки и API на основе Compose, следуйте лучшим практикам, чтобы сделать ваш код масштабируемым, более производительным и согласованным с остальной экосистемой.

Следующие документы содержат рекомендации для всех, кто пишет код с использованием Compose:

  • Руководство по API для Jetpack Compose : описывает шаблоны, лучшие практики и предписывающие рекомендации по стилю для любой системы, использующей плагин компилятора и среду выполнения Jetpack Compose. Оно включает следующие темы:
    • Рекомендации по стилю Kotlin для Compose, основанные на соглашениях о кодировании Kotlin.
    • Руководство по использованию функций и API с @Composable , основанных на возможностях среды выполнения 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 .