रात में दंतकथाएं - सफलता की कुंजी के रूप में अच्छे नाम

सभी को शुभ दिन।

"जैसा कि आप एक नाव कहते हैं, इसलिए यह तैर जाएगी" - एक प्रसिद्ध प्रसिद्ध वाक्यांश जो फ़ंक्शन, चर, कक्षाओं के लिए काफी उपयुक्त है।

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

उदाहरण के लिए

enum Dates{
GET_FIRST,
GET_SECOND,
GET_BOTH,
None
}



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

Boolean IsInRange( DateTime date1, DateTime date2, Dates pDates) {
if (pDates==Dates.GET_BOTH) {
return date1 <= myDate && myDate <= date2;
}
if (pDates==Dates.GET_FIRST) {
return date1 <= myDate && myDate < date2;
}
if (pDates==Dates.GET_SECOND) {
return date1 < myDate && myDate <= date2;
}
return date1 < myDate && myDate < date2;
}



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

enum DateIntervals{
Open,
Closed,
OpenLeft,
OpenRight
}


इस मामले में, यह संभावना नहीं है कि आपको कोड पर चढ़ना होगा, एनाम का उपयोग करने के स्थानों की तलाश में - उसका नाम पहले से ही उसकी प्रकृति की बात करता है।

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

नाम बताया।

• GetPCF
• GetYYYY
• GetNN

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

उपसर्गों
शक्तिशाली विकास के वातावरण की अनुपस्थिति के समय (सब कुछ अपेक्षाकृत सीमित है), उपसर्गों को अपनाया गया था।

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

• एक सरणी (सरणी)
• बी बूल बूलियन पूर्णांक (एक बाइट)
• BYTE द्वारा अहस्ताक्षरित पूर्णांक
• सी चरित्र (एक बाइट)
• C वर्ग
• डी डबल प्रिसिजन नंबर (डबल)
• ....

अब भी, यह हो रहा है। इसमें लिप्त न हों। खींचें उपसर्गों के बजाय तार्किक रूप से एक चर का नाम दें।

नाम कब तक होना चाहिए?
यदि वैरिएबल यूसेज ब्लॉक 3 लाइनों तक सीमित है, तो यह वेरिएबल को फर्स्टइंडेक्सइन्सेरक्लेओलेशन के रूप में नाम देने के लिए बहुत कम समझ में आता है। नाम की लंबाई सीधे ब्लॉक की लंबाई के लिए आनुपातिक है। जितना बड़ा ब्लॉक, उतना बड़ा नाम।

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

संक्षेप में:

• ऐसे नामों का उपयोग करें जो आपके इरादे व्यक्त करते हैं। तब बहुत समय बचेगा।
• टिप्पणियों का पालन करें, एक नियम के रूप में यह थोड़ा रिफैक्टिंग की आवश्यकता का संकेत है।
• नाम का उच्चारण आसान होना चाहिए।
• उन प्रत्ययों और उपसर्गों को न डालें जो केवल आपके लिए समझ में आते हैं।
• कार्यों के लिए, क्रिया + संज्ञा / विशेषण से प्राप्त नामों का उपयोग करें
• गलत सूचना से बचें - फ़ंक्शन को वही करना चाहिए जो उसका नाम बताता है, अन्यथा यह फ़ंक्शन की निरंतर मेमोरी में बदल जाएगा।
• बेस कक्षाओं में संक्षिप्त नाम होना चाहिए। प्रत्येक वारिस आमतौर पर एक शब्द जोड़ता है। और वारिस के वारिस अभी तक। तो यह एक लंबा परावर्तन हो सकता है

खुश कोडिंग।