🍩 🤫 💃🏽 शुद्ध कोड: कारण और प्रभाव ⚒️ 🎣 🚓

लेखक: विक्टर Svirsky, वरिष्ठ पायथन डेवलपर / टीम लीड, डेटाआर्ट

कितने प्रोग्रामर, इतनी सारी परिभाषाएँ, स्वच्छ कोड क्या है। साक्षात्कार करते समय, मैं अक्सर सुनता हूं कि अच्छा कोड वह है जिसे पढ़ना आसान है। मैं सहमत हूं, लेकिन जैसा कि मेरा व्यक्तिगत अनुभव बताता है, यह केवल हिमशैल का सिरा है।

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

बाहरी - जैसे व्यवसाय से दबाव और नई कार्यक्षमता को तेज़ी से प्राप्त करने की इच्छा।
आंतरिक - खराब रूप से विकसित विकास प्रक्रियाएं और टीम के भीतर बातचीत, नियंत्रण और विकास मानकों की कमी या क्षमता की कमी।

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

क्लीन कोड क्या है?

यह कहना सही है कि कोड साफ है और सिस्टम को सही तरीके से डिजाइन किया गया है, कोड का आसान पठन पर्याप्त नहीं है। उसके पास अन्य गुण होने चाहिए:

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

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

क्या मुझे क्लीन कोड लिखना चाहिए?

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

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

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

आपके कोड को बेहतर बनाने में क्या मदद करेगा?

अधिकांश प्रोग्रामर जल्दी और खूबसूरती से कोड लिखने का सपना देखते हैं, ताकि सब कुछ पहली बार पूरी तरह से काम करे। लेकिन हर कोई कोड को न केवल काम करने में सफल होता है, बल्कि समझ में आता है। क्लीन कोड लिखने में कैसे सफल हों? दो तरीके हैं - स्व-संगठन और टीमवर्क।

स्व-संगठन

व्यक्तिगत कोड गुणवत्ता में सुधार के कई संभावित तरीकों पर विचार करें। ये सिफारिशें किसी भी स्तर पर डेवलपर्स के लिए उपयुक्त हैं।

, — . — . IDE ( ) , , . IDE , . — .

. , .
open source
. , . , . !
, . . . , , 10, , . .

. -, .
. . . .

. .
. . - . , .

— , , , , .
, . — .
!

, .

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

कोड की समीक्षा
यह समझ और निष्पादन के लिए एक सरल सिद्धांत है। कोड के लेखक सहित कम से कम दो लोग कोड की जांच करते हैं।

अपना कोड जाँचते समय कई बातों पर ध्यान देना चाहिए:
- उनमें से एक यह जांचना है कि कोड कोड समझौते के नियमों का उल्लंघन करता है या नहीं। यह एक ऐसी प्रक्रिया है जो सीआई (निरंतर एकीकरण) में स्थिर विश्लेषक का उपयोग करके स्वचालित की जा सकती है और होनी चाहिए।
- अन्य कोड मेंटेनेंस और एरर हैंडलिंग हैं जिन्हें स्वचालित रूप से सत्यापित नहीं किया जा सकता है।
- , , . , ?
(Continuous integration)

, .

, :
- . . , . , , .
- , , .
(Coding onventions)

. , . , , .

, , , . . , , . , . , . .

, , . — , - .

. , . .
, . , , .

, . , . , , .

-. . , . . , .
, , . . , .

, :
- ? , . , .
- ?
- ()?
- ?
- — ?
, , . , .
, . SonarQube. :
- — . , . , .
- , — DRY (Don’t repeat yourself).
- . . . , .
- , , , .
- . , . , .

***

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

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

शुद्ध कोड: कारण और प्रभाव

क्लीन कोड क्या है?

क्या मुझे क्लीन कोड लिखना चाहिए?

आपके कोड को बेहतर बनाने में क्या मदद करेगा?

स्व-संगठन

***

More articles: