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

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

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

  • Руководство по API для Jetpack Compose : описывает шаблоны, передовой опыт и стилистические рекомендации для любой системы, использующей плагин компилятора и среду выполнения Jetpack Compose. Включает следующие темы:
    • Руководящие принципы стиля Kotlin для Compose, основанные на соглашениях о кодировании Kotlin
    • Руководство по функциям @Composable и API, которые основаны на возможностях среды выполнения Compose
    • Рекомендации по API, которые используют и расширяют набор инструментов Compose UI
    • Шаблоны для рассмотрения вариантов использования при проектировании API Compose
  • Руководство по API для компонентов @Composable в Jetpack Compose : предоставляет набор рекомендаций и рекомендаций по созданию и использованию компонентов пользовательского интерфейса @Composable , включая следующие темы:
    • Создание и наложение компонентов
    • Присвоение имени новому компоненту
    • Выражение зависимостей компонентов
    • Параметры в компонентах @Composable
    • Следование правильным шаблонам создания классов и функций, связанных с компонентами
    • Документирование компонентов @Composable
    • Улучшение доступности компонентов
    • Updating component APIs while retaining backwards compatibility

Аудитория

Эти рекомендации написаны для следующих трех аудиторий:

  • Разработчики, создающие приложения на основе Jetpack Compose . Вы входите в эту группу, если используете Jetpack Compose в какой-либо части своего приложения.
  • Разработчики, работающие над фреймворком Jetpack Compose . Вы входите в эту группу, если вносите вклад в библиотеки androidx.compose .
  • Разработчики, создающие библиотеки на основе Jetpack Compose . Вы входите в эту группу, если создаёте API Compose или библиотеки элементов пользовательского интерфейса Compose. Эти библиотеки компонентов Compose могут быть общедоступными или локальными для вашей компании или команды.

В зависимости от группы, к которой вы относитесь, существуют разные уровни строгости для каждого правила стиля. Например, разработка фреймворка Jetpack Compose, как правило, наиболее строго придерживается этих правил.

Более подробную информацию о требованиях для каждой аудитории разработчиков см. в RFC2119 .

Внести вклад в разработку рамок и руководств

Мы приветствуем вклад в разработку отдельных библиотек в кодовой базе androidx , а также руководств по стилю ( руководства по Compose API и руководства по компонентам @Composable ).

Чтобы внести свой вклад, следуйте инструкциям в руководстве по внесению вклада androidx .