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

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

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

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