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

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

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

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