دستورالعمل‌های سبک برای Jetpack Compose API

اگر درحال نوشتن کد Compose برای برنامه‌تان هستید یا درحال ساختن کتابخانه‌ها و میاناهای برنامه‌سازی کاربردی Compose هستید، روال‌های مطلوب را دنبال کنید تا کدتان مقیاس‌پذیر، کاراتر، و با بقیه بوم‌سازگان سازگار باشد.

اسناد زیر دستورالعمل‌هایی را برای هر کسی که کدی می‌نویسد که از Compose استفاده می‌کند ارائه می‌دهد:

  • رهنمودهای میانای برنامه‌سازی کاربردی برای Jetpack Compose: الگوها، روال‌های مطلوب، و رهنمودهای سبک تجویزی را برای هر سیستمی که از افزونه کامپایلر و زمان اجرای Jetpack Compose استفاده می‌کند، شرح می‌دهد. این شامل موضوعات زیر است:
    • دستورالعمل‌های سبک Kotlin برای Compose، براساس قراردادهای کدنویسی Kotlin
    • راهنمایی برای @Composable تابع و میانای برنامه‌سازی کاربردی که بر قابلیت‌های زمان اجرای Compose ساخته شده‌اند
    • رهنمودهایی برای میاناهای برنامه‌سازی کاربردی که از جعبه ابزار Compose UI استفاده می‌کنند و آن را گسترش می‌دهند
    • الگوهای رسیدگی به موارد استفاده هنگام طراحی Compose API
  • رهنمودهای میانای برنامه‌سازی کاربردی برای مؤلفه‌های @Composable در Jetpack Compose: مجموعه‌ای از رهنمودها و توصیه‌ها را برای ایجاد و استفاده از مؤلفه‌های میانای کاربر @Composable ارائه می‌دهد، ازجمله موضوعات زیر:
    • درحال ساختن و لایه‌بندی قطعات
    • نام‌گذاری مؤلفه جدید
    • بیان وابستگی‌های مؤلفه
    • پارامترها در مؤلفه‌های @Composable
    • دنبال کردن الگوهای صحیح برای ایجاد کلاس‌ها و توابع مرتبط با مؤلفه
    • درحال مستندسازی @Composable مؤلفه
    • بهبود دسترس‌پذیری برای مؤلفه‌ها
    • به‌روزرسانی میاناهای برنامه‌سازی کاربردی مؤلفه با حفظ سازگاری با نسخه قدیمی

مخاطب

این دستورالعمل‌ها برای سه مخاطب زیر نوشته شده‌اند:

  • توسعه‌دهندگانی که براساس Jetpack Compose برنامه می‌سازند. اگر در بخشی از برنامه‌تان از Jetpack Compose استفاده می‌کنید، در این گروه قرار دارید.
  • توسعه‌دهندگانی که روی توسعه چارچوب Jetpack Compose کار می‌کنند. اگر در کتابخانه‌های androidx.compose همیاری کنید، در این گروه قرار می‌گیرید.
  • توسعه‌دهندگانی که کتابخانه‌هایی براساس Jetpack Compose ایجاد می‌کنند. اگر میاناهای برنامه‌سازی کاربردی Compose یا کتابخانه‌های عناصر میانای کاربر Compose را ایجاد می‌کنید، در این گروه قرار دارید. این کتابخانه‌های مؤلفه‌های Compose ممکن است به‌صورت عمومی دردسترس باشند یا به‌صورت محلی برای شرکت یا تیم شما ارائه شوند.

بسته به گروهی که در آن هستید، سطوح سخت‌گیری متفاوتی برای هر دستورالعمل سبک دارید. برای مثال، توسعه چارچوب Jetpack Compose معمولاً به‌طور جدی از این دستورالعمل‌ها پیروی می‌کند.

برای اطلاعات بیشتر درباره الزامات هر مخاطب توسعه‌دهنده، به RFC2119 مراجعه کنید.

مشارکت در چارچوب و دستورالعمل‌ها

از مشارکت در انتخاب کتابخانه‌ها در پایگاه کد androidx و خودِ دستورالعمل‌های سبک (دستورالعمل‌های Compose API و دستورالعمل‌های مؤلفه‌های @Composable) استقبال می‌کنیم.

برای همیاری، دستورالعمل‌های مندرج در راهنمای همیاری androidx را دنبال کنید.