كيف أكتب مراجعة التعليمات البرمجية؟

2024 مؤلف: Lynn Donovan | [email protected]. آخر تعديل: 2024-01-18 08:21

10 نصائح لإرشادك نحو مراجعة أكواد الأقران الفعالة

1. إعادة النظر أقل من 400 سطر من الشفرة في الوقت.
2. خذ وقتك.
3. لاتفعل إعادة النظر لأكثر من 60 دقيقة في المرة الواحدة.
4. حدد الأهداف والتقاط المقاييس.
5. يجب على المؤلفين التعليق على المصدر الشفرة قبل إعادة النظر .
6. استخدم قوائم المراجعة.
7. إنشاء عملية لإصلاح العيوب التي تم العثور عليها.

وبالمثل ، متى يجب عليك مراجعة الكود؟

متى مراجعة كود الاستعراضات يجب أن يتم إجراؤها بعد اكتمال عمليات التحقق الآلية (الاختبارات ، والأسلوب ، وغير ذلك من CI) بنجاح ، ولكن قبل الشفرة يدمج في الفرع الرئيسي للمستودع. نحن عموما لا نؤدي بشكل رسمي مراجعة التعليمات البرمجية من إجمالي التغييرات منذ الإصدار الأخير.

بالإضافة إلى ذلك ، كيف تجري Google مراجعات التعليمات البرمجية؟ لإثبات قدرتهم على كود المراجعة لسهولة القراءة والمطورين في متصفح الجوجل اذهب من خلال " إعادة النظر من هم مراجعة التعليمات البرمجية الممارسات ". لذلك ، يقدم المطور الشفرة تغييرات على فريق من خبراء القراءة. هؤلاء سوف يتفقدون الشفرة . لكن هذا التفتيش ليس كالمعتاد مراجعة التعليمات البرمجية.

السؤال أيضًا هو ، كيف ترمز مثل المراجعة البشرية؟

التقنيات

1. دع أجهزة الكمبيوتر تقوم بالأجزاء المملة.
2. تسوية الحجج على غرار دليل الأسلوب.
3. ابدأ المراجعة فورًا.
4. ابدأ بمستوى عالٍ واعمل في طريقك إلى الأسفل.
5. كن كريما مع أمثلة التعليمات البرمجية.
6. لا تقل "أنت"
7. إطار التغذية المرتدة كطلبات وليس أوامر.
8. ربط الملاحظات بالمبادئ وليس الآراء.

ما الذي يجعل مراجعة جيدة للكود؟

مراجعات جيدة للكود اطرح أسئلة مفتوحة بدلاً من الإدلاء ببيانات قوية أو معبرة. أنها توفر بدائل والحلول الممكنة التي قد تعمل بشكل أفضل للموقف دون الإصرار على هذه الحلول هي أفضل أو الطريقة الوحيدة للمضي قدما.