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

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


في الوقت نفسه ، يتحدث عدد قليل من الأشخاص عن المبادئ التي يجب اتباعها لإجراء مراجعة الجودة: ما هي الأهداف الرئيسية لهذا الإجراء ، وما الذي تبحث عنه في المقام الأول ، ومدى سرعة تنفيذه.


لذلك ، يبدو دليل مراجعة Google بمثابة مستند قيم للغاية ، ويتم تقديم ترجمة الجزء الأول منه لاحقًا. سيتم نشر ترجمات الأجزاء المتبقية في وقت لاحق في وظائف منفصلة. من الجدير بالذكر أن هذه ترجمة معدلة ، وليست جميعها مترجمة كلمة بكلمة ، باسم المزيد من الصيغ والجمل الروسية.


المصطلح:


CL : "قائمة التغيير" - قائمة تغييرات التعليمات البرمجية المرسلة إلى نظام التحكم في الإصدار للمراجعة. تناظرية لطلب السحب في GitHub أو طلب الدمج في GitLab.


1. مراجعة رمز المعايير


الغرض الرئيسي من المراجعة هو تحسين قاعدة كود Google. تهدف جميع الأدوات والوسائل المستخدمة لإجراء المراجعة على وجه التحديد إلى تحقيق هذا الهدف.


في الطريق إلى تحقيق الهدف المعلن ، يجب علينا تقديم عدد من التنازلات.


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


, CL , . , . , .


, . , , , " ".


, , :


CL , , CL .


.


, : CL , , , .


, : , . CL , , CL , , . , , . CL, , , , .


, , , , . , , "Nit: ", .


: CL, . .


1.1.


- , , . , , - . , . , ( ), "Nit: " .


1.2.


  • .
  • style guide .
    , style guide . , .
  • .
    / , . .
    , , , . .
  • , , , , .

1.3.


, , , , : CL .


, : . , CL, .


, — , , , . CL "" , .


2.


: - .


2.1. ()


, — CL . CL? : ? ? ?


2.2.


CL , ? ? "" ( ), , .


, . , , , , , , .


, CL: , . , .


, — CL . , — . , , . ( ).


2.3.


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


, , , . , , , , . , .


2.4.


, , : , end-to-end . , CL, .
.


— , , .
, ? , ? , ? ?


, — , . , , .


2.5.


, . , , , , .


2.6.


, ? ? , , , , , : , . , . , , , : , .


, CL: , "TODO", , .


, — , . , .


2.7.


Google , . , CL .


, , ("Nit:"). CL .


CL . , . , , , CL — , .


2.8.


CL , , , , , README, g3doc (. — Google ) . CL , , . , .


2.9.


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


, , , . Google . , , , , . , , , , .


, , , . , , , , .


2.10.


, , . , , : , , 4 , , 50 .


CL : CL , ?
CL, . , , CL.


2.11.


CL , : , . , , .



:


  • ,
  • ,
  • : , ,
  • ,
  • ,
  • ,
  • ,
  • , , ,
  • , , ( ),
  • (g3doc),
  • -.

يجب عليك إلقاء نظرة على كل سطر من التعليمات البرمجية ، مع مراعاة السياق ، والتأكد من أنك تقوم بتحسين حالة قاعدة التعليمات البرمجية وتشجيع قرارات المطور الناجحة.


في الجزء التالي ، سنناقش كيفية التنقل بشكل أفضل في CL وأين تبدأ المراجعة.

Source: https://habr.com/ru/post/undefined/


All Articles