اصطلاحات التسمية

تحدد هذه الصفحة قواعد التسمية الداخلية التي تجعل مساحة العمل قابلة للتوقع للمساهمين.

الأهداف

استخدم model لتمثيل نموذج البيانات المعرّف من طرف المستخدم أو الدوال النقية التي تتحقق منه وتطبّعه
استخدم runtime لعلامات ECS الداخلية، وتتبع الأبناء المُولّدين، والأنظمة التي تملك الشجرة الحية للوحدة
استخدم state للحالة طويلة العمر التي تقرؤها وتحدّثها عدة أنظمة
استخدم events للرسائل الصادرة وللشيفرة التي تترجم تغيّر الحالة إلى إشعارات خارجية
استخدم translation لمنطق تحويل البيانات المعرّفة إلى إعدادات runtime أو solver
استخدم placement لمنطق تموضع الأبناء بعد معرفة الأحجام
تجنب الأسماء العامة مثل types أو helpers أو display عندما يتوفر اسم أكثر دقة

يجب أن تتبع الإضافات النمط Univis<Name>Plugin
يجب أن تتبع مجموعات الجدولة النمط Univis<Domain>Set أو Univis<Stage>Set
يجب أن تحتفظ مكوّنات الواجهة العامة بالبادئة U*
يجب أن تستعمل علامات runtime الداخلية أسماء صريحة مثل SelectTrigger أو PanelResizeHandle أو UiWorkState
يجب أن تنتهي الموارد التي تضبط السلوك باللاحقة Settings
يجب أن تنتهي الموارد أو المكوّنات التي تتتبع التقدّم الحي باللاحقة State

قبل إنشاء وحدة جديدة أو إعادة تسميتها، تأكد من:

هل يصف اسم الملف المسؤولية بدلًا من التفصيل التنفيذي؟
هل يستطيع مساهم جديد أن يعرف هل تنتمي الشيفرة إلى model أو runtime أو state أو events أو translation أو placement؟
هل يطابق الاسم الجديد أنماط الإضافات والمكوّنات والحالات الموجودة في الوحدات الشقيقة؟