कोड निरीक्षण कोड सहयोगी उपकरण का उपयोग करना

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

चेतावनी! इस लेख में हम अन्य निरीक्षण स्वचालन उपकरण (क्रूसिबल, गेरिट) के साथ काम करने के फायदे या नुकसान का उल्लेख नहीं करते हैं - उनके साथ अनुभव की कमी के कारण। इसलिए, एक उद्देश्य तुलना की उम्मीद न करें :)

मेल द्वारा पैचिंग के माध्यम से निरीक्षण योजना निम्नलिखित कारणों से बहुत असुविधाजनक है:

1. इसमें बहुत सारे मैनुअल पैच वर्क लगते हैं।
2. कोड के ब्लॉकों के लिए बाध्यकारी के साथ बातचीत के लिए कोई सुविधाजनक उपकरण नहीं हैं, खासकर अगर दो से अधिक प्रतिभागी हैं।
3. कोड के वास्तविक निरीक्षण पर कोई नियंत्रण नहीं है।

यह समझ कि यह विकल्प हमारे लिए उपयुक्त नहीं है, ने हमें इन समस्याओं को हल करने के बारे में सोचा।

क्या आप अभी भी उबल रहे हैं? फिर हम आपके पास जाते हैं!

हमारा अनुभव बताता है कि यदि निरीक्षणों का कार्यान्वयन श्रमसाध्य है, तो उन्हें औपचारिक रूप से किया जाएगा: “मैंने देखा। यह सामान्य लगता है। ” इस दृष्टिकोण के साथ, निरीक्षण डेवलपर्स के लिए एक नौकरशाही बोझ में बदल जाता है और किसी भी तरह से किया जाता है, बस दिखाने के लिए, और ज्ञान और अनुभव के आदान-प्रदान, कोड की गुणवत्ता में सुधार के बग़ल में चलते हैं।

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

एक निरीक्षण दस्तावेज बनाने में आसानी:

• फाइलें जोड़ने;
• प्रतिभागियों की नियुक्ति;
• कोड या बग-ट्रैकर के लिंक द्वारा किए गए परिवर्तनों का विवरण।

प्रतिभागियों को स्वचालित सूचनाएं:

• निरीक्षण के लिए नियुक्ति पर;
• निरीक्षण कोड में नए बदलाव जोड़ना;
• नई टिप्पणियों के बारे में;
• समय-समय पर निरीक्षण के बारे में।

निरीक्षण नेविगेशन में आसानी:

• कोड नेविगेशन;
• मांग पर परिवर्तन के आसपास प्रदर्शित कोड वर्गों का विस्तार करने की क्षमता;
• वार्तालाप देखें और नेविगेट करें
• केवल अपठित टिप्पणियों पर प्रकाश डाला और नेविगेशन।

प्रतिभागियों के बीच बातचीत की सुविधा:

• कोड के एक ब्लॉक के बारे में कई प्रतिभागियों की बातचीत का संगठन;
• वार्तालाप शाखाओं पर नेविगेशन की सुविधा;
• आसानी से सुधारों को जोड़ना और उनसे बातचीत को जोड़ना।

अंत में, निरीक्षणों के आर्थिक लाभों को प्रदर्शित करने के लिए प्रबंधन के लिए प्रतिक्रिया और रिपोर्टिंग के लिए मीट्रिक एकत्र करने का अवसर।

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

जावा में लिखे गए स्थानीय डेस्कटॉप क्लाइंट, उनके क्रॉस-प्लेटफॉर्म से प्रसन्न हैं। CodeCollaborator की मुख्य कार्यक्षमता वेब इंटरफ़ेस में केंद्रित है, इसलिए यह Mac OS और Unix सिस्टम के लिए अनुकूल है। कार्यक्षमता का हिस्सा स्थानीय डेस्कटॉप अनुप्रयोगों और विज़ुअल स्टूडियो और ग्रहण के लिए प्लग इन में सुविधा के लिए दोहराया गया है।

हम सीसी की स्थापना और प्रारंभिक कॉन्फ़िगरेशन को छोड़ देते हैं, क्योंकि यह सरल और अच्छी तरह से प्रलेखित है। आइए एक परीक्षण परियोजना पर CodeCollaborator के साथ काम का विश्लेषण करें।

स्थिति: डेवलपर ने परियोजना में तीन फाइलें जोड़ीं और कई दोषों को खोजने वाले सहयोगियों के निरीक्षण के लिए उन्हें भेजा। उसके बाद, लेखक ने पाया त्रुटियों को ठीक करता है और पुन: निरीक्षण के लिए अपडेट भेजता है। उनके सहकर्मी दोषों के सुधार की शुद्धता को सत्यापित करते हैं और इन परिवर्तनों को अनुमोदित करते हैं, जिससे लेखक को सामान्य भंडार में परिवर्तनों को शामिल करने की अनुमति मिलती है।

एक निरीक्षण कुछ ही क्लिक में बनाया गया है। विजुअल स्टूडियो या ग्रहण के प्लगइन्स हमें निरीक्षण निर्माण विंडो (मौजूदा निरीक्षण में फ़ाइलों को जोड़ने के लिए) के रूप में निर्देशित करते हैं।



निरीक्षण के लिए भेजी जाने वाली फाइलें जोड़ें:



CodeCollaborator संस्करण नियंत्रण प्रणाली के शीर्ष पर चलता है (हमारे मामले में, यह SVN है)। कार्यक्रम सबसे आम संस्करण नियंत्रण प्रणाली का समर्थन करता है।

डिफ़ॉल्ट रूप से, स्थानीय वर्किंग कॉपी में सभी जोड़ी और बदली गई फ़ाइलों को निरीक्षण में जोड़ा जाएगा।

युक्ति: विभिन्न कार्यों के लिए अपनी स्वयं की कार्य प्रतिलिपि रखना बहुत सुविधाजनक है, उदाहरण के लिए, डिफ़ॉल्ट रूप से फ़ाइलों की संपूर्ण सूची को जोड़ने के बजाय, उन्हें एक समय में एक से दूर करने के बजाय।

उसके बाद, डेस्कटॉप क्लाइंट स्वचालित रूप से हमें निरीक्षकों की नियुक्ति पृष्ठ पर पुनर्निर्देशित करता है, जहां हम निरीक्षण प्रतिभागियों को इंगित करते हैं और निरीक्षण प्रक्रिया स्वयं शुरू करते हैं।



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



निरीक्षक कोड की जाँच करता है और उसकी समीक्षा लिखता है। एक सुविधाजनक निरीक्षण नेविगेशन पैनल इस कार्य को बहुत सरल करता है: अगली (पिछली) फ़ाइल में संक्रमण, अगले (पिछले) वार्तालाप पर लागू किया जाता है।



नेविगेशन बार के बटनों को गर्म कुंजियों द्वारा दोहराया जाता है।

एक टिप्पणी बनाने या एक दोष को ठीक करने के लिए, बस कोड की वांछित रेखा पर क्लिक करें और दिखाई देने वाली खिड़की में टिप्पणी पाठ लिखें, और एक दोष के मामले में, इसके महत्व और प्रकार को इंगित करें।





सभी कोड की समीक्षा करने के बाद, निरीक्षक निरीक्षण प्रक्रिया के पूरा होने को चिह्नित करता है। यदि खुले दोष हैं, तो सिस्टम स्वचालित रूप से "त्रुटियों पर कार्य" मोड में निरीक्षण करता है; यदि सभी दोष बंद हो गए हैं, तो निरीक्षण को "पूर्ण" स्थिति में स्थानांतरित कर दिया गया है। इसके अलावा, निरीक्षक एक नोट डालने में सक्षम होगा कि उसने निरीक्षण पूरा किया - केवल सभी टिप्पणियों को पढ़ने और निरीक्षण में सभी फाइलों को मंजूरी देने के बाद (दुर्घटना से कुछ याद करना मुश्किल है)।

कोड के लेखक देखता है कि निरीक्षण "नियम" त्रुटि स्थिति में है, सभी खुले दोष सारणीबद्ध हैं, प्रत्येक फ़ाइल के सामने दोष और टिप्पणियों वाले आइकन दिखाई देते हैं। सभी प्रतिभागियों को एक ही सारांश दिखाई देता है।



जो बातचीत शुरू हुई है वह देखने में सुविधाजनक है।



लेखक बग पर काम करता है और निरीक्षण में संशोधित कोड जोड़ता है। एक कोड जोड़ने की प्रक्रिया एक निरीक्षण बनाने की प्रक्रिया के समान है, केवल मौजूदा एक को नए के बजाय इंगित किया गया है; डिफ़ॉल्ट रूप से फ़ाइलें भी जोड़ी जाती हैं।

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

निरीक्षकों द्वारा दोषों को बंद करने के बाद निरीक्षण समाप्त हो जाता है और सभी संशोधित फाइलें अनुमोदित हो जाती हैं।



अब लेखक अपने कोड को सामान्य रिपॉजिटरी में जोड़ सकता है। मानक कोडकॉलबोरेटर रिपोर्ट प्रभावी कार्य के लिए काफी पर्याप्त हैं: उपकरण बड़ी संख्या में फिल्टर प्रदान करता है।

यहाँ उपयोगी रिपोर्ट के एक जोड़े हैं। निरीक्षण पर खर्च किए गए समय पर रिपोर्ट:



गंभीरता के साथ दोष रिपोर्ट = समय की अवधि के लिए प्रमुख:



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

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