إرشادات النمط لواجهات برمجة التطبيقات Jetpack Compose

إذا كنت تكتب رمز Compose لتطبيقك أو تنشئ مكتبات وواجهات برمجة تطبيقات Compose، اتّبِع أفضل الممارسات لجعل الرمز قابلاً للتوسّع وأكثر فعالية ومتوافقًا مع بقية النظام الأساسي.

تقدّم المستندات التالية إرشادات لأي شخص يكتب رمزًا يستخدم Compose:

• إرشادات واجهة برمجة التطبيقات لـ Jetpack Compose: تحدّد الأنماط وأفضل الممارسات والإرشادات الوصفية للأنماط لأي نظام يستخدم مكوّن Jetpack Compose الإضافي للمترجم ووقت التشغيل. ويتضمّن المستند المواضيع التالية:
  • إرشادات أنماط Kotlin لـ Compose، استنادًا إلى اصطلاحات ترميز Kotlin
  • إرشادات لوظائف @Composable وواجهات برمجة التطبيقات التي تستند إلى إمكانات وقت تشغيل Compose
  • إرشادات لواجهات برمجة التطبيقات التي تستخدم مجموعة أدوات واجهة مستخدم Compose وتوسّعها
  • أنماط لمعالجة حالات الاستخدام عند تصميم واجهة برمجة تطبيقات Compose
• إرشادات واجهة برمجة التطبيقات لمكوّنات @Composable في Jetpack Compose: تقدّم مجموعة من الإرشادات والاقتراحات لإنشاء مكوّنات واجهة مستخدم @Composable واستخدامها، بما في ذلك المواضيع التالية:
  • إنشاء المكوّنات ووضعها في طبقات
  • تسمية مكوّن جديد
  • تحديد تبعيات المكوّن
  • المَعلمات في مكوّنات @Composable
  • اتّباع الأنماط الصحيحة لإنشاء الفئات والوظائف ذات الصلة بالمكوّنات
  • توثيق مكوّنات @Composable
  • تحسين إمكانية الوصول إلى المكوّنات
  • تعديل واجهات برمجة تطبيقات المكوّنات مع الاحتفاظ بالتوافق مع الأنظمة القديمة

الجمهور

تمت كتابة هذه الإرشادات للجمهور الثلاثة التالي:

• المطوّرون الذين ينشئون تطبيقات تستند إلى Jetpack Compose : تنتمي إلى هذه المجموعة إذا كنت تستخدم Jetpack Compose في جزء من تطبيقك.
• المطوّرون الذين يعملون على تطوير إطار عمل Jetpack Compose : تنتمي إلى هذه المجموعة إذا كنت تقدّم مساهمات إلى مكتبات androidx.compose.
• المطوّرون الذين ينشئون مكتبات تستند إلى Jetpack Compose : تنتمي إلى هذه المجموعة إذا كنت تنشئ واجهات برمجة تطبيقات Compose أو مكتبات لعناصر واجهة مستخدم Compose. قد تكون مكتبات مكوّنات Compose هذه متاحة للجميع أو محلية في شركتك أو فريقك.

اعتمادًا على المجموعة التي تنتمي إليها، لديك مستويات صرامة مختلفة لكل إرشاد من إرشادات الأنماط. على سبيل المثال، يلتزم تطوير إطار عمل Jetpack Compose بهذه الإرشادات بشكل صارم بشكل عام.

لمزيد من المعلومات عن متطلبات كل جمهور من المطوّرين، يُرجى الاطّلاع على RFC2119.

المساهمة في إطار العمل والإرشادات

نرحّب بالمساهمات في مكتبات معيّنة في قاعدة رموز androidx وإرشادات الأنماط (إرشادات واجهة برمجة تطبيقات Compose و إرشادات مكوّنات @Composable) نفسها.

للمساهمة، اتّبِع التعليمات الواردة في androidx دليل المساهمة.