3.4 KiB
تعليق الكود الخاص بك
التعليمات
الكود النظيف والمُوثق جيدًا ضروري للحفاظ على مشاريعك ومشاركتها. في هذه المهمة، ستتمرن على واحدة من أهم عادات المطورين المحترفين: كتابة تعليقات واضحة ومفيدة تشرح الغرض من الكود ووظيفته.
راجع ملف app.js الحالي في مجلد اللعبة الخاص بك، وابحث عن طرق لإضافة التعليقات وتنظيمه. من السهل أن يصبح الكود غير منظم، وهذه فرصة جيدة لإضافة تعليقات لضمان أن يكون الكود قابلًا للقراءة حتى تتمكن من استخدامه لاحقًا.
مهمتك تشمل:
- إضافة تعليقات تشرح ما يفعله كل قسم رئيسي من الكود
- توثيق الوظائف بوصف واضح لغرضها ومعاملاتها
- تنظيم الكود في كتل منطقية مع عناوين للأقسام
- إزالة أي كود غير مستخدم أو زائد عن الحاجة
- استخدام تسميات متسقة للمتغيرات والوظائف
معايير التقييم
| المعايير | ممتاز | مقبول | يحتاج إلى تحسين |
|---|---|---|---|
| توثيق الكود | كود app.js موثق بالكامل مع شروحات واضحة ومفيدة لجميع الأقسام الرئيسية والوظائف |
كود app.js موثق بشكل كافٍ مع شروحات أساسية لمعظم الأقسام |
كود app.js يحتوي على تعليقات قليلة ويفتقر إلى شروحات واضحة |
| تنظيم الكود | الكود منظم في كتل منطقية مع عناوين واضحة للأقسام وهيكل متسق | الكود يحتوي على بعض التنظيم مع تجميع أساسي للوظائف ذات الصلة | الكود غير منظم إلى حد ما ويصعب متابعته |
| جودة الكود | جميع المتغيرات والوظائف تستخدم أسماء وصفية، لا يوجد كود غير مستخدم، يتبع قواعد متسقة | معظم الكود يتبع ممارسات تسمية جيدة مع وجود كود غير مستخدم بشكل قليل | أسماء المتغيرات غير واضحة، يحتوي على كود غير مستخدم، أسلوب غير متسق |
إخلاء المسؤولية:
تم ترجمة هذا المستند باستخدام خدمة الترجمة بالذكاء الاصطناعي Co-op Translator. بينما نسعى لتحقيق الدقة، يرجى العلم أن الترجمات الآلية قد تحتوي على أخطاء أو عدم دقة. يجب اعتبار المستند الأصلي بلغته الأصلية المصدر الرسمي. للحصول على معلومات حاسمة، يُوصى بالترجمة البشرية الاحترافية. نحن غير مسؤولين عن أي سوء فهم أو تفسيرات خاطئة تنشأ عن استخدام هذه الترجمة.