कोड की पढ़ने योग्य तीन नियम
डवलپر्स के रूप में, हम फंक्शनल कोड लिखने का प्रयास करते हैं, लेकिन साथ ही यह आसान हो理解 और मेंटेन करने के लिए भी। इस लेख में, हम कोड के पढ़ने योग्य तीन नियम का पता लगाएंगे, जो आपको एक बेहतर प्रोग्रामर बनने में मदद करेंगे और आपके कोड रिव्यू को आसान बना देंगे।
क्या आपका कोड सच बोलता है?
"लॉ 1: सेल्फ-डॉक्यूमेंटिंग कोड लिखें"
पढ़ने योग्य कोड का पहला नियम सेल्फ-डॉक्यूमेंटिंग कोड लिखना है। इसका मतलब है कि कोड स्पष्ट और संक्षिप्त होना चाहिए, जिससे दूसरों के लिए यह समझना आसान हो कि यह क्या करता है। एक अच्छा उदाहरण यह है कि एक फंक्शन जो सर्किल का एरिया कैलकुलेट करता है। इसके बजाय कि फंक्शन के बारे में कमेंट हो, फंक्शन नाम स्वयं व्याख्यात्मक होना चाहिए, जैसे calculateAreaOfCircle
。 इससे अनावश्यक कमेंट की आवश्यकता समाप्त हो जाती है और कोड अधिक पढ़ने योग्य हो जाता है।
मैजिक नंबर्स से बचें
पढ़ने योग्य कोड का दूसरा नियम मैजिक नंबर्स से बचना है। मैजिक नंबर्स वे संख्यात्मक मูล्य हैं जो कोड में बिना किसी व्याख्या के प्रकट होते हैं। वे कोड को समझने और मेंटेन करने में कठिन बना देते हैं। एक बेहतर दृष्टिकोण यह है कि इन मूल्यों के लिए व्याख्यात्मक नामित निरंतर का उपयोग करें। उदाहरण के लिए, यदि एक फंक्शन किसी निश्चित थ्रेशहोल्ड पर टैक्स कैलकुलेट करता है, तो आप एक कॉस्टेंट HIGH_VALUE_ITEM_TAX
परिभाषित कर सकते हैं और फंक्शन में इसका उपयोग कर सकते हैं। इससे कोड अधिक पढ़ने योग्य और आसान हो जाता है।
फंक्शन पैरामीटर्स से बचें
"लॉ 3: फंक्शन पैरामीटर्स से बचें"
पढ़ने योग्य कोड का तीसरा नियम फंक्शन पैरामीटर्स से बचना है। जब एक फंक्शन में बहुत से पैरामीटर्स होते हैं, तो यह कोड को समझने और मेंटेन करने में कठिन बना देता है। एक बेहतर दृष्टिकोण यह है कि इन सभी फील्ड्स के लिए एक ऑब्जेक्ट क्रिएट करें और फिर उसके ऑब्जेक्ट को बनाने के लिए एक बिल्डर का उपयोग करें। इससे कोड अधिक पढ़ने योग्य और आसान हो जाता है।
निष्कर्ष
इन तीन नियमों का पालन करके, आप कोड लिख सकते हैं जो आसान हो समझना और मेंटेन करना। याद रखें, पढ़ने योग्य कोड का लक्ष्य यह है कि दूसरों के लिए कोड क्या करता है, इसके बारे में आसानी से समझना हो, बिना किसी कमेंट या अनावश्यक जटिलता के। सेल्फ-डॉक्यूमेंटिंग कोड लिख कर, मैजिक नंबर्स से बच कर, और फंक्शन पैरामीटर्स से बच कर, आप कोड रिव्यू को आसान कर सकते हैं और एक बेहतर प्रोग्रामर बन सकते हैं।