👦🏼 👩🏾‍🔬 😺 टिप्पणियों में कोड की समीक्षा करें 💒 ☘️ 🐼

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

पूर्व शर्त

शाखाओं में विकसित सुविधाओं / कार्यों / बगों (उदाहरण के लिए, gitflow) के लिए एक कार्यान्वित कार्यप्रणाली के साथ वितरित संस्करण नियंत्रण प्रणाली (git, मर्क्यूरियल, बाज़ार) का उपयोग करते हुए विधि एक छोटी सी टीम के लिए रुचिकर होगी। टीम में कोड संपादक विशिष्ट कीवर्ड के लिए टिप्पणियों का समर्थन करते हैं (उदाहरण के लिए, TODO)। कोड की समीक्षा के लिए एक पूरी तरह से कार्यात्मक विशेष उपकरण लागू नहीं किया जा सकता है, क्योंकि उन्हें भुगतान किया जाता है और बजट में एक पंक्ति नहीं होती है; या तो मुक्त, लेकिन स्थापित करने में आसान या संदिग्ध प्रयोज्य नहीं है या किसी विशेष मामले में, वे गौरैया-राजा तोप हो सकते हैं।

प्रक्रिया है

सामान्य विचार यह है कि सुविधाओं (बग, कार्य) को अलग-अलग शाखाओं में विकसित किया जाता है, एक ला गिटफ्लो, और फिर एक निश्चित सर्वर पर प्रकाशित किया जाता है - आप केंद्रीय भी कर सकते हैं। समीक्षक TODO शैली में टिप्पणियां लिखते हैं, लेकिन एक विशेष टैग के साथ, उदाहरण के लिए "REV":

$ourcoolcode = 123; // REV      ? echo $ourcoolcode;

टिप्पणी सिंटैक्स

 /** * $TAG $status $title * $commentor1 $comments * $commentorN $comments */

$ TAG - प्रोजेक्ट कोड के लिए अद्वितीय, TODO नहीं, XXX आदि,, लेकिन, उदाहरण के लिए, REV। वर्तमान प्रोजेक्ट कोड में टिप्पणियों में मौजूद नहीं होना चाहिए।
$ स्थिति - एक वैकल्पिक पैरामीटर जो स्थिति को इंगित कर सकता है: "+" - सवाल बंद है या समस्या हल हो गई है; "!" - हमारे पास एक समस्या है, और पात्रों की संख्या समस्या की गंभीरता को इंगित कर सकती है।
$ शीर्षक - सवाल / समस्या का शीर्षक।
$ टिप्पणीकार 1 / $ टिप्पणीकार - (वैकल्पिक) टिप्पणीकारों के कुछ पदनाम दूसरों से कुछ टिप्पणियों को अलग करने के लिए।
$ टिप्पणियाँ - या तो सवाल / समस्या के लेखक की टिप्पणियाँ, जब सब कुछ शीर्षक में फिट नहीं होता है, या उत्तर देने वाले की टिप्पणियां।

विशिष्ट भाषा के आधार पर टिप्पणियाँ एकल-पंक्ति या बहु-पंक्ति हो सकती हैं।

कोई भी आधुनिक IDE TODO को निकाल और फ़िल्टर कर सकता है। ग्रहण और नेटबीन्स यह सुनिश्चित करने के लिए कर सकते हैं, और JetBrains और अन्य भुगतान किए गए संपादक बस ऐसा करने के लिए बाध्य हैं। परिणामस्वरूप, आप थ्रेड में टिप्पणियों को तब तक बदल सकते हैं जब तक कि सब कुछ स्पष्ट न हो जाए और वे समाप्त हो जाएं। प्रक्रिया के अंत में, जब कोड बेहतर हो जाता है, तो आप सुरक्षित रूप से शाखा को स्क्वैश कर सकते हैं और मुख्य एक (विकसित) को मर्ज कर सकते हैं। अंत में सभी टिप्पणियां मिट जाती हैं और कोड में नहीं पड़ना चाहिए, जो हुक के साथ लगाया जा सकता है।

शून्य में सार उदाहरण

पेशेवरों और विपक्ष

विधि के लाभ:

न्यूनतम कार्यान्वयन लागत - बिल्कुल मूल उपकरण का उपयोग किया जाता है - मानक सेटिंग्स / प्लगइन्स और एक संस्करण नियंत्रण प्रणाली के साथ एक संपादक;
प्रश्न और दोष संपादक में तुरंत दिखाई देते हैं;
एक हवाई जहाज पर काम करता है: (जैसे गिट और अन्य DVcs);
कोड के साथ काम करते समय, हम तुलना मोड खोल सकते हैं, देखें कि क्या बदला गया है और यहां विशेष टिप्पणियां लिखें

और निश्चित रूप से नुकसान (वर्कअराउंड के साथ):

घुटने टेकना और यह तथ्य कि अब हम एक निश्चित उपकरण नहीं स्थापित कर रहे हैं, लेकिन हमारे संपादक और रिपॉजिटरी में हुक लगा रहे हैं, हालांकि: हुक को एक बार लिखा जा सकता है और गिथब पर रखा जा सकता है; एक बार टूल की ट्यूनिंग का भी वर्णन करें और विकी को चित्रों के साथ गीथूब पर अपलोड करें;
आपको कुछ अनुशासन बनाए रखने की आवश्यकता है और सम्मेलनों का पालन करना चाहिए, जो केवल सामान्य साधनों में मजबूर हैं, हालांकि हुक की मदद से पूरी तरह से सब कुछ व्यवस्थित किया जा सकता है: क्या टिप्पणियां रह सकती हैं? विकसित / मास्टर में उनके साथ आने की अनुमति न दें; क्या कमिट लॉग "वाम" के साथ भरा हो सकता है? उन्हें संकुचित करें और मुख्य शाखाओं में पहले से ही पूर्ण डालें;
लंबी टिप्पणियों या चर्चाओं की वाक्य रचना और समस्या;
इतिहास का संरक्षण: अंतिम विकल्प में, एक विकल्प के रूप में, एक निकाय को और अधिक रंग दें और जिस पर चर्चा की गई थी और जो आया था।

निष्कर्ष

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

टिप्पणियों में कोड की समीक्षा करें