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

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

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

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

الجمهور

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

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

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

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

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

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

لتقديم مساهمة، يُرجى اتّباع التعليمات الواردة في دليل المساهمة في androidx.