एक डेवलपर के जीवन में, एक समय आता है जब वह एक कोड समीक्षा करना शुरू करता है। एक नियम के रूप में, यह एक प्रोग्रामर के विकास के संकेतों में से एक है: वे वास्तव में उसकी राय को सुनना शुरू करते हैं और अधिक गंभीर कार्यों पर भरोसा करते हैं। जब किसी डेवलपर से समीक्षा करने के लिए कहा जाता है, तो वह सटीक क्षण कंपनी की संरचना पर निर्भर करता है: ऐसी टीमें होती हैं, जहां कम या ज्यादा सब कुछ हो सकता है, कुछ समय बीत जाने के बाद, और ऐसी भी होती हैं, जहां समीक्षा प्रक्रिया पूरी तरह से सबसे पुराने और सबसे अनुभवी सहयोगियों के साथ आराम करती है।

इसी समय, कुछ लोग इस बारे में बात करते हैं कि गुणवत्ता की समीक्षा करने के लिए किन सिद्धांतों का पालन किया जाना चाहिए: इस प्रक्रिया के मुख्य लक्ष्य क्या हैं, पहली जगह में क्या देखना है, कितनी जल्दी इसे पूरा करने की आवश्यकता है।

इसलिए, Google समीक्षा मार्गदर्शिका एक बहुत ही मूल्यवान दस्तावेज की तरह दिखती है, जिसके पहले भाग का अनुवाद बाद में प्रस्तुत किया गया है। शेष हिस्सों के अनुवाद बाद में अलग-अलग पदों पर जारी किए जाएंगे। यह ध्यान देने योग्य है कि यह एक अनुकूलित अनुवाद है, सभी को अधिक रूसी योगों और वाक्यों के नाम से शब्द-दर-शब्द अनुवादित नहीं किया गया है।

शब्दावली:

सीएल : "चैंजिस्ट" - समीक्षा के लिए संस्करण नियंत्रण प्रणाली के लिए भेजे गए कोड परिवर्तनों की एक सूची। 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),
• -.

आपको कोड की प्रत्येक पंक्ति को देखना चाहिए , संदर्भ को ध्यान में रखना चाहिए, सुनिश्चित करें कि आप कोड आधार की स्थिति में सुधार कर रहे हैं और डेवलपर डेवलपर निर्णयों को प्रोत्साहित करेंगे।

अगले भाग में, हम चर्चा करेंगे कि सीएल में बेहतर नेविगेट कैसे करें और समीक्षा कहाँ शुरू करें।