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

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

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

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

الجمهور

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

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

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

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

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

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

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