كيف تتم مراجعة الكود؟ الجزء الثاني: مراجعة الملاحة والسرعة والتعليقات والتضارب

في الجزء الأول من المقال أبرز جوانب معايير مراجعة التعليمات البرمجية والنقاط التي تحتاج إلى معالجة أولا. في الجزء الأخير ، لنتحدث عن:


  • مراجعة الإجراء
  • السرعة (وما يؤثر عليها)
  • كيفية كتابة التعليقات ،
  • المناقشة أثناء المراجعة.

1. التنقل عبر قائمة التغييرات في المراجعة


TL ؛ د


الآن بعد أن فهمت ما تحتاج إلى الانتباه إليه ، عليك أن تقرر ما هو ترتيب المراجعة. هناك 3 مراحل رئيسية:


  1. فهم ما إذا كانت الوظيفة المعروضة ضرورية من حيث المبدأ وما إذا كانت تحتوي على وصف جيد ؛
  2. الانتباه إلى أهم شيء في التعليمات البرمجية المعدلة ومدى تصميم الحل ككل ؛
  3. اعرض التغييرات المتبقية بالترتيب الذي تراه مناسبًا.

1.1. نظرة عامة على التغيير


انظر إلى وصف CL ووظيفته الرئيسية: هل هذه التغييرات مطلوبة؟ إذا لم تكن الوظيفة المقترحة مطلوبة ، فحاول الإبلاغ عنها في أقرب وقت ممكن واشرح الأسباب. في هذه الحالة ، يُنصح بتقديم مهمة للمطوّر في المقابل.


: " , , , FooWidget, . . , BarWidget . ?"


, : CL . : , .


, , , — , . "" , , .


1.2.


CL — , . — . CL , , CL .


CL, , CL . , , — .


:


  • CL . , .
  • . , , , .

1.3.


CL , . . , . — .


2.


2.1. - ?


Google , , , . , .


, - :


  • . , , , . , , , , .
  • . , . . , , , CL , . , .
  • . , . , CL.

2.2. ?


- , , .


( , , ).


, CL ( ) .


2.3. vs


, : - , , , . , , . , , , .


: , , , .


2.4.


-, , , , , CL . , .


, , .


, , , CL , . . , — .


, , . , , .


2.5.


, , , , . , .


2.6. LGTM (looks good to me = )


, , CL . :


  • , .
  • , .

LGTM , "LGTM, Approval".


2.6. CL


CL , CL CL, . , .


CL , , CL, , . , , .


2.7. -


, , . , CL . . , , — , .


2.8.


, CL . . , , " ".


3.


TL;DR


  • .
  • .
  • , , .
  • , .

3.1.


, , , , . — , . , , , -, . :


: " , ?"


: " , , . , , ."


3.2.


"" , . , — , .


3.3.


CL, . .


. , , . , , , , , , , , .


, . , CL , — , .


3.4.


, , , . , , , , .


, , . : , , , , , .


4.


, .


4.1. ?


, — , . , . ? ? , .


, . , . , - .


, , , . .


, . , . , .


4.2. ?


, , . , , , , , . , , , . , , .


4.3. " "


( ) , . , - CL, . CL . , , CL, - . , . , — , , , "". .


CL , CL , . CL , , , , TODO- .


4.4.


, , . .


, , , .


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


4.5. حل النزاعات


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


All Articles