إرشادات النمط لواجهات برمجة التطبيقات 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 هذه متاحة للجميع أو خاصة بشركتك أو فريقك.

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

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

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

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

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