اگر در حال نوشتن کد Compose برای برنامه خود هستید یا در حال ساخت کتابخانه‌ها و APIهای Compose هستید، از بهترین شیوه‌ها پیروی کنید تا کد شما مقیاس‌پذیر، کارآمدتر و سازگار با بقیه اکوسیستم باشد.
اسناد زیر دستورالعمل‌هایی را برای هر کسی که کدی می‌نویسد که از Compose استفاده می‌کند، ارائه می‌دهد:
- دستورالعمل‌های API برای Jetpack Compose : الگوها، بهترین شیوه‌ها و دستورالعمل‌های سبک تجویزی را برای هر سیستمی که از افزونه و زمان اجرای کامپایلر Jetpack Compose استفاده می‌کند، تشریح می‌کند. این شامل مباحث زیر است:
- دستورالعمل‌های سبک کاتلین برای Compose، بر اساس قراردادهای کدنویسی کاتلین
- راهنمایی برای توابع و APIهای
@Composableکه بر اساس قابلیت‌های زمان اجرای Compose ساخته می‌شوند - دستورالعمل‌هایی برای APIهایی که از جعبه ابزار رابط کاربری Compose استفاده می‌کنند و آن را گسترش می‌دهند
- الگوهایی برای پرداختن به موارد استفاده هنگام طراحی یک 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 را دنبال کنید.