अपने कोड के लिए सार्थक नाम कैसे आएं

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



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

चूंकि हम इतना समय नामों को सौंपने में लगाते हैं, इसलिए इसे गुणवत्तापूर्ण तरीके से करना बहुत महत्वपूर्ण है। इस लेख में मैं आपको कुछ सरल नियमों के बारे में बताऊंगा, जिनके अनुसरण से आप अच्छे नाम बना सकते हैं। आखिरकार, यह एक पूरी कला है!

उन नामों का उपयोग करें जो आपके इरादों को प्रकट करते हैं

नाम को कोड के उद्देश्य को इंगित करना चाहिए। आसान काम से कहा, है ना? प्रोग्रामर के इरादे के बारे में कुछ नहीं कहने वाले नामों के साथ आप कितनी बार चर पर आते हैं?

नियम यह है: यदि किसी नाम के लिए टिप्पणी की आवश्यकता होती है, तो यह इरादे को व्यक्त नहीं करता है।

इस कोड स्निपेट में एक चर है, जिसके नाम से इसका उद्देश्य स्पष्ट नहीं है:

<?php private $s; // Time in seconds 

$s चर हमें कुछ भी नहीं बताता है और एक समय अवधि के साथ जुड़ा नहीं है। एक नाम चुनना बेहतर है जो यह इंगित करेगा कि क्या और किन इकाइयों में इसे मापा जाता है।

नीचे दिए गए नामों में से एक अधिक उपयुक्त होगा।

 <?php private $days_since_creation; private $elapsed_time_in_seconds; private $seconds_since_last_modified; 

इरादे नाम कोड को समझने में आसान बनाते हैं, और इसलिए बनाए रखने में आसान होते हैं।

आप सही नाम चुनने में समय बिताएंगे, लेकिन भविष्य में इसे बचाएंगे।

इस उदाहरण पर विचार करें:

 <?php function getList() { $list1 = []; foreach ($this->the_list as $x) { if ($x % 2 != 0) { $list1[] = $x; } } return $list1; } function getOddNumbers() { $odd_numbers = []; foreach ($this->numbers as $number) { if (isOdd($number)) { $odd_numbers[] = $number; } } return $odd_numbers; } 

यह समझना कठिन है कि getList फ़ंक्शन getList ? कोई जटिल अभिव्यक्ति नहीं, कोड सही ढंग से संरेखित और स्वरूपित है, बस तीन चर और कुछ नहीं।

अब getOddNumbers फ़ंक्शन को देखें। क्या आपने देखा कि वह getList की तरह ही काम getList ?

ध्यान दें कि कोड अधिक जटिल या सरल नहीं हो गया है। हमने ऑपरेटर, चर और घोंसले के स्तर की संख्या रखी, लेकिन अब यह अधिक स्पष्ट और पारदर्शी है।

नाम में एक छोटा सा बदलाव - और यह समझना बहुत आसान है कि क्या हो रहा है।

गलत सूचना से बचें

कोड के उद्देश्य को विकृत करने वाले झूठे संघों से बचने की कोशिश करें।

उन शब्दों का उपयोग न करें, जिन्हें आपके इच्छित तरीके से अलग तरीके से समझा जा सकता है। उदाहरण के लिए, उत्पाद समूह के productList न productList , जब तक कि यह वास्तव में टाइप List का ऑब्जेक्ट न हो। इस तरह के नाम से गलत निष्कर्ष निकल सकते हैं। सिर्फ products का उपयोग करना बेहतर है।

शायद चरों के लिए सबसे खराब नाम एक अपरकेस अक्षर O और एक लोअरकेस L , क्योंकि ये अक्षर 0 और 1 के समान हैं।

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

सार्थक अंतर को उजागर करें

नंबरिंग का उपयोग करना नामकरण का सबसे अच्छा तरीका नहीं है। इस तरह के नाम असंगत हैं, क्योंकि वे लेखक के इरादों को प्रकट नहीं करते हैं।

आइए निम्नलिखित उदाहरण देखें:

 <?php public function duplicateArray($arr1, &$arr2) { foreach ($arr1 as $key => $value) { $arr2[$key] = $value; } } 

अगर हम $arr1 और $arr2 से $source और $destination नाम बदलें तो यह कोड स्निपेट बेहतर $arr2 से $arr2 ।

उन नामों का उपयोग करें जिनका आप उच्चारण कर सकते हैं

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

मान लीजिए कि आपके पास $xsq नामक एक चर है और आप अक्सर कंपनी के साथ इस पर चर्चा करते हैं। और यहाँ आप एक सहयोगी के साथ बात कर रहे हैं:
- अच्छा, यह पूर्व ईएसई क्व्यू के साथ क्या है?
- किसके साथ? पहुँच कतार के साथ?

कुछ डेवलपर्स एक शब्द के रूप में चर के नाम का उच्चारण करेंगे, और कुछ संक्षिप्त नाम के रूप में।

खोजा नाम का उपयोग करें

एकल-अक्षर नामों के साथ समस्या यह है कि उन्हें कोड में खोजना मुश्किल है।

संख्यात्मक स्थिरांक के साथ एक ही बात। उन्हें चरों के साथ बदलना बेहतर है। उदाहरण के लिए, सामान्य संख्या 8 में बहुत सारी समस्याएं हो सकती हैं यदि आपको कोड में कुछ खोजने की आवश्यकता है। हालाँकि, अगर आप MAX_BLOCKS_DISPLAYED जैसी किसी चीज़ से नंबर को बदलते हैं तो यह बहुत आसान हो जाएगा।

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

कक्षा सदस्य उपसर्ग

M_ उपसर्गों का उपयोग न करें।

कुछ डेवलपर्स को कक्षा सदस्यों के सामने एक अंडरस्कोर उपसर्ग का उपयोग करने की आदत है। ऐसा मत करो। आपकी कक्षाएं और विधियाँ पर्याप्त रूप से कॉम्पैक्ट होनी चाहिए ताकि आपको इनमें से किसी भी उपसर्ग की आवश्यकता न हो।

वैकल्पिक रूप से, आप आईडीई का उपयोग कर सकते हैं (या प्लगइन स्थापित कर सकते हैं), जो उनके दायरे के आधार पर चर को उजागर करता है।

जंगल में एक पिकनिक स्पॉट के रूप में अपने कोड के बारे में सोचें - आपके आने से पहले इसे क्लीनर छोड़ दें।

निष्कर्ष

इस तरह से कोड के लिए अधिक व्यापक नाम बनाए जाते हैं।

टिप्पणी करें, अपने प्रश्नों को छोड़ दें और लिखें यदि आप चाहते हैं कि मैं प्रोग्रामिंग से संबंधित अन्य विषयों को कवर करूं।

यह लेख रॉबर्ट मार्टिन की पुस्तक क्लीन कोड से प्रेरित था, जिसे मैं पढ़ने की अत्यधिक सलाह देता हूं।