अच्छी प्रोग्रामिंग के लिए तीन नियम

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

1. लोगों के लिए कोड लिखें, कार नहीं।
2. अपने आप को दोहराएं नहीं।
3. प्रत्येक कोड का एक कार्य करना चाहिए।

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

लोगों के लिए कोड लिखें, कार नहीं

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

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

आपका संकलक (या दुभाषिया) पूरी तरह से कोड की विभिन्न शैलियों को संभाल सकता है। उसके लिए, n और numberOfObjects एक ही चीज हैं। लोगों के लिए, नहीं। कोड में उन्हें लंबे समय तक पढ़ा जाएगा, भले ही चर का उद्देश्य आपको स्पष्ट प्रतीत हो।

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

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

ऐसा कोड लिखें जिसे लोग समझ सकें।

अपने आप को दोहराएं नहीं

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

जब आप एक ही टुकड़े को कई स्थानों पर दोहराते हैं, तो जल्द ही या बाद में आपको कुछ गलती को ठीक करने या कुछ नया जोड़ने के लिए वापस आना होगा। इससे कोड रखरखाव मुश्किल हो जाता है। अपने आप को दोहराने के बजाय, एक अलग वर्ग या फ़ंक्शन में टुकड़ा डालें जिसे आप जितनी जल्दी हो सके पहुंच सकते हैं। यदि आप एक ही क्रम में अलग-अलग स्थानों में कई तरीके कहते हैं, तो इसे एक अलग फ़ंक्शन में लपेटें।

सोचें कि कोड से परिचित होने पर समझने में क्या आसान होगा: मेमोरी के एक ब्लॉक को मुक्त करने के लिए 30-लाइन का टुकड़ा, या क्लियरपावरवीरेबलमोरी () फ़ंक्शन के लिए कॉल?
आपको बाद में टुकड़े का अध्ययन करने की आवश्यकता हो सकती है, लेकिन फिर भी, एक अलग कार्य के साथ काम करना आसान होगा।

डेटा पर एक ही सिद्धांत लागू किया जा सकता है। यदि आप अक्सर एक ही चर का उपयोग करते हैं, तो उन्हें एक अलग वर्ग या डेटा प्रकार में स्थानांतरित करें।

यदि आप इस नियम का पालन करते हैं, तो सभी परिवर्तन सार्वभौमिक होंगे - आपको छोटे संशोधन करने के लिए दर्जनों स्थानों पर प्रक्रिया करने की आवश्यकता नहीं है।

अपने आप को दोहराएं नहीं।

प्रत्येक कोड का एक कार्य करना होगा।

अंतिम नियम दो पिछले वाले पर आधारित है: आपके कोड के प्रत्येक टुकड़े को केवल एक ही कार्य करना चाहिए। यह सभी स्तरों पर सही है: अभिव्यक्तियों, कार्यों और विधियों, कक्षाओं और वस्तुओं के लिए।

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

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

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

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

आपके कोड के प्रत्येक टुकड़े को एक कार्य करना चाहिए।

निष्कर्ष

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

---

लेख का अनुवाद 3 सरल नियमों में अच्छा प्रोग्रामिंग ।