कोड समीक्षाएं: कोड समीक्षा कैसे करें इस पर एक पूर्ण मार्गदर्शिका

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

कोड समीक्षा क्या है?

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

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

कोड समीक्षा का महत्व

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

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

अपने कोड समीक्षा कौशल का मुद्रीकरण करें

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

यह एकमात्र ऐसी स्थिति है जहां आप अपने कोड की मुफ्त में समीक्षा करने की उम्मीद कर सकते हैं: हर दूसरे अवसर पर, आपको एक साथी डेवलपर (एक बाहरी व्यक्ति या विकास टीम में एक सदस्य जोड़कर) को काम पर रखना होगा। यदि हम इसे विपरीत दृष्टिकोण से देखते हैं, तो एक डेवलपर होने के नाते, कोड समीक्षा आपके लिए एक नौकरी का अवसर है!

कोड समीक्षा कैसे करें

कोड समीक्षा के लिए तैयार करें

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

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

• किस तरह का सॉफ्टवेयर बनाया जा रहा है
• लक्ष्य क्या है
• प्रसंग क्या है
• लेखक की प्राथमिकताएँ क्या हैं (सौंदर्यशास्त्र? प्रदर्शन?)

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

कोड समीक्षा चेकलिस्ट

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

de-बग

आपकी कोड समीक्षा चेकलिस्ट पर नंबर 1 हमेशा डिबगिंग होता है। जैसा कि हमने देखा, कई कारण हैं कि आप एक कोड समीक्षा क्यों चलाना चाहते हैं, लेकिन निश्चित रूप से, सभी मुद्दों को डीबग करना और हटाना आपकी प्राथमिकता है।

बग गलत वर्तनी वाले चर, गलत क्रम में पैरामीटर और अन्य साधारण गलतियों से आ सकते हैं; कोड के लेखक आमतौर पर उन्हें खोज नहीं सकते क्योंकि वे थके हुए हैं और क्योंकि वे बार-बार उस कोड से गुज़र चुके हैं (यही कारण है कि टेक्स्ट का लेखक टाइपो की जांच करने वाला व्यक्ति नहीं है!) .

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

सुरक्षा

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

कोड पठनीयता

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

कोड दोहराव

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

नामकरण

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

परीक्षण

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

• कोड में परीक्षण हैं या नहीं
• उन परीक्षणों की गुणवत्ता
• परीक्षणों की पठनीयता
• परीक्षणों के भीतर नामकरण।

प्रलेखन

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

सुधार की संभावना

जब आप किसी ऐसे कोड की समीक्षा कर रहे होते हैं जिसे आपने बार-बार नहीं लिखा था, तो आपके पास अतिरिक्त सुविधाओं, पहलुओं के बारे में विचार हो सकते हैं जो प्रदर्शन या सुरक्षा को बढ़ा सकते हैं, या सामान्य रूप से सुधार कर सकते हैं। अपनी कोड समीक्षा चेकलिस्ट के दौरान, आप न केवल इसकी जाँच कर रहे हैं कि यह क्या है, बल्कि आप इस बारे में भी सलाह दे रहे हैं कि परियोजना को सामान्य रूप से या इसके एकल पहलुओं में कैसे सुधार किया जाए।

इस बिंदु पर, आपको अपने आप से पूछना चाहिए कि क्या परियोजना में सुधार करने के तरीके हैं ताकि आप या तो स्वयं परिवर्तन कर सकें या कोड के लेखक को आपके द्वारा देखी गई संभावनाओं के बारे में सूचित कर सकें।

परिवर्तनों को ट्रैक करता है

आपकी कोड समीक्षा चेकलिस्ट के अंतिम बॉक्स से अधिक, आपको संपूर्ण समीक्षा प्रक्रिया के दौरान कोड में आपके द्वारा किए गए परिवर्तनों को ट्रैक करना चाहिए। यह महत्वपूर्ण है कि जब आप कोड के लेखक को अपनी प्रतिक्रिया दें (अगला पैराग्राफ देखें), तो आप परिवर्तनों को दिखाने और उन्हें समझाने में सक्षम हैं।

अपनी प्रतिक्रिया दें

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

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

यदि आपने अपनी समीक्षा के दौरान कोड में परिवर्तन किए हैं, तो आप यह सुनिश्चित करना चाहते हैं कि आप न केवल लेखक (या लेखक) को कोड के बारे में सूचित करें बल्कि यह भी कि आप यह समझाने में भी सक्षम हैं कि आपने वे परिवर्तन क्यों और कैसे किए हैं और क्या वे परियोजना में किस तरह का सुधार लाते हैं।

क्या नो-कोड प्रोग्रामिंग के लिए कोड समीक्षा आवश्यक है?

जैसा कि आप निश्चित रूप से पहले से ही जानते हैं, जब आप बिना कोड वाले प्लेटफॉर्म के साथ कोई ऐप बनाते हैं तो आप सीधे कोड नहीं लिख रहे होते हैं। यदि आप ऐपमास्टर जैसे शीर्ष-नो-कोड टूल का उपयोग कर रहे हैं - आज बाजार में सबसे अधिक अनुशंसित नो-कोड प्लेटफॉर्म - स्रोत कोड स्वचालित रूप से उत्पन्न होता है। क्या इसका मतलब यह है कि उस कोड को कोड समीक्षा की आवश्यकता नहीं है क्योंकि यह किसी मानव द्वारा नहीं बल्कि ऐसी मशीन द्वारा बनाया गया था जो गलती नहीं करता है?

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

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

निष्कर्ष

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