مرحبا يا هبر! أقدم لكم ترجمة المقال "6 نصائح لمراجعة مدونة ناجحة" .
كانت مراجعة الكود دائمًا الممارسة الأساسية لإنشاء كود نظيف وقابل للصيانة.
غالبًا ما يهمل المطوّرون ويقللون من مراجعة الكود لأسباب تبدو صحيحة بشكل موضوعي في ذلك الوقت.
فلنضع 6 نصائح اليوم لإجراء مراجعة جيدة ومثمرة للشفرة .
أنا - اختر اللحظة المناسبة
تبدأ مراجعة الكود باختيار اللحظة المناسبة .
دعنا نحاول وصف خصائصه:
- فرصة منخفضة للانقطاع : يجب عليك تجنب ساعات العمل ، حيث يميل الناس ، على أساس الخبرة ، إلى صرف الانتباه عن عملية العمل. في الواقع ، غالبًا ما تكون هناك فترات أكثر هدوءًا في بعض الأيام ، وفي مثل هذه اللحظات ، يجدر التخطيط لمراجعة الكود.
- عقل نظيف وواضح : يجب ألا تواجه التوتر قبل بدء المراجعة وفي العملية ، على سبيل المثال ، خوفًا من اجتماع قادم مع العميل. أيضًا ، يجب أن يكون المبرمج الذي سيتم فحص الكود الخاص به في حالة هدوء حتى لا يوجد توتر بينك يمكن أن يدمر عملية مراجعة الكود.
- يضمن المطور أن الكود جاهز للتحقق منه : لا جدوى من إضاعة الوقت في النظر إلى ما هو غير جاهز بعد. عن طريق الاستعداد يعني أن الشفرة تعمل ، دون ممارسة سيئة ، موثقة ، وعلى الأقل مغطاة باختبارات الوحدة. استنادًا إلى الخبرة ، إذا قام أحد مطوري البرامج بتخصيص وقت لمراجعة الكود ، فمن المرجح أن يقدم رمزًا للتحقق لا يشعر بالخجل منه.
ثانيا - تعيين الحدود
يجدر بنا أن نفهم مقدما النطاق القادم لمراجعة الكود.
النظر في واحد أو أكثر من الميزات؟ بالنظر إلى الوقت ، هل من المنطقي التفكير كثيرًا؟
كقاعدة عامة ، أريد التركيز على عدد محدود من التغييرات من أجل فهم أفضل لما يدور حوله ، وعدم الانتقال في كثير من الأحيان بين أجزاء التعليمات البرمجية.
لتعيين حدود المهمة بشكل صحيح ، يمكنك:
- أداء المهام المعينة ذات حجم مرئي . للقيام بذلك ، قسّم المهام الكبيرة إلى مهام صغيرة وذرية ، على سبيل المثال ، في Jira أو حتى على لوح Scrum الكلاسيكي.
- حدد أولوية التحقق من صحة الشفرة بشكل صحيح : إذا كانت هناك مهام كثيرة تنتظر التحقق ، فلن تتمكن من رؤية كل شيء. اختر الأولوية.
ثالثا - ضبط الجو المناسب
قبل البدء في مراجعة الكود ، أنشئ جوًا مناسبًا من حولك.
ما هو المطلوب لهذا؟
- الحد الأدنى لعدد الأصوات الدخيلة : ستكون أكثر إنتاجية إذا كان هناك ضجيج أقل قدر ممكن. بعد كل شيء ، كلما كان أصغر ، كان التركيز أفضل.
- لا توجد منطقة "انقطاع" : على غرار ما تم وصفه في الجزء الأول ، فإن الأمر يستحق تجنب اللحظات التي يمكن أن تمزق فيها العملية. من الأسهل القيام بذلك في غرفة منفصلة.
- مجال النقد الإيجابي : انتقاد عمل شخص آخر هو عملية معقدة. لكن الأمر أكثر صعوبة عند القيام بذلك عندما يكون هناك الكثير من الناس. في غرفة مغلقة ، يمكنك التحدث بحرية دون خوف من التعرض للتنصت.
IV - الدردشة والدردشة والدردشة مرة أخرى
التحقق من الكود ليس عملية أحادية الاتجاه.
تعتمد مراجعة الشفرة الناجحة بشكل كبير على القدرة على التواصل مع الزميل باحترام وفعالية. بعد كل شيء ، ليس فقط المفتش يعلن ما هو صحيح وما هو غير صحيح.
مراجعة الشفرة هي محادثة حول كل شيء: النطاق ، النوايا ، التصحيحات ، وحتى الاختلافات.
في هذه العملية ، حاول الالتزام بالتوصيات التالية:
- لا تستمع فحسب ، بل تسمع أيضًا : تختلف الآراء والآراء غالبًا ، ويجب أن يؤدي كل خلاف إلى نقاش بناء حول هذه القضية. كل وجهة نظر تحتاج إلى عناية.
- لهجة محايدة : التحقق من الكود ليس اختبارًا أو محاكم التفتيش ، اجعله يبدو أنك جئت للحكم على الكود ، وليس الشخص الذي كتبه.
- شكوك عذاب - حدد : إذا كنت غير متأكد من تفاصيل التنفيذ المحددة ، اسأل عنها. غالبًا ما تؤدي بعض النوايا غير الواضحة للوهلة الأولى إلى سوء التفسير في المستقبل.
الخامس - تذكر الهدف النهائي
يجب أن تؤدي مراجعة التعليمات البرمجية إلى النتيجة النهائية: يمكن أن تكون نقدًا بناءًا ونصائح لتحسين أو دمج التعليمات البرمجية مع فروع التطوير المقابلة التي تم تحديدها في gitflow.
هذه هي مسؤولية المراجع.
ولكن كيف يمكنك الحكم على ما إذا كان يمكن دمج الكود؟
فيما يلي بعض المعايير للمساعدة في اتخاذ القرار:
- الرمز المكتوب يحل المشكلة الموضحة في البيان.
- يتم تغطية الكود بشكل صحيح عن طريق اختبارات الوحدة .
- صحيح حل الصراعات دمج.
- لا توجد علامات واضحة على رائحة الكود أو الممارسات السيئة .
سادسا - استخدام أدوات خاصة
هناك أدوات لسهولة التحقق من الرمز. يمكنك استخدامها دون تردد لتبسيط عملية مراجعة الكود والتكامل.
تتصدر ثلاث علامات تجارية سوق برمجيات التحقق من الكود: Smartbear (مع Collaborator) ، و Perforce (مع Helix Swarm) ، و Atlassian (مع Crucible)
غالبًا ما توفر هذه الأدوات أدوات شاملة لتنظيم مراجعة الشفرة ، فضلاً عن المقاييس للحفاظ على تحسن فريقك باستمرار.
هذا أكثر بكثير من مجرد أدوات لمقارنة الشفرة ، وهي تتكامل مع جميع أنظمة التحكم في الإصدار المتوفرة تقريبًا.
جربه!
حان دورك للمشاركة!
إذا كانت لديك نصائح إضافية أو أمثلة محددة حدثت لك في الحياة اليومية للمطورين ، شاركها في التعليقات.