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

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

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

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

مخاطب

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

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

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

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

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

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

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