प्रोग्रामिंग के सुझाव

अच्छा कोड लिखने के बारे में सामान्य सुझाव


फंक्शन का नाम रखना

अच्छा कोड लिखने के लिए फंक्शन के अच्छे नाम चुनना बहुत ज़रूरी है। अपने फंक्शन का नाम रखते समय इन सुझावों पर ध्यान दीजिए।

फंक्शन के नाम सार्थक चुनिए

जब आप अपने फंक्शन का नाम रखें, तो यह साफ़ होना चाहिए कि वह क्या करता है। उदाहरण के लिए, get(studentId, subject) फंक्शन का नाम सार्थक नहीं है, इसलिए यह साफ़ नहीं होता कि वह क्या करता है। वह विद्यार्थी के किसी विषय का ग्रेड निकाल रहा हो सकता है, या उसकी नामांकन स्थिति देख रहा हो सकता है। इससे बेहतर नाम होगा getStudentGrade(studentId, subject), क्योंकि यह ठीक-ठीक बताता है कि फंक्शन क्या करता है।

फंक्शन का नाम बहुत लंबा न रखिए

ध्यान रखिए कि फंक्शन का नाम बहुत लंबा न हो जाए। उदाहरण के लिए, checkStudentFailOrPassOrMeritOrDistinction(mark) ज़रूरत से ज़्यादा लंबा फंक्शन नाम है। नाम जितना लंबा होगा, उसे याद रखना उतना ही कठिन होगा और कंप्यूटर की स्क्रीन पर वह उतनी ही जगह घेरेगा।

फंक्शन का नाम बहुत छोटा न रखिए

इसके उलट, फंक्शन का नाम बहुत छोटा रखने से पढ़ने वाले भी उलझ सकते हैं। उदाहरण के लिए, checkFPMD(mark) खराब फंक्शन नाम है, क्योंकि तुरंत समझ नहीं आता कि 'FPMD' का मतलब क्या है।

वह नाम रखिए जिसे हर कोई समझ सके।

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

कामों के नाम रखने के लिए एक ही तरीका अपनाइए

जो काम एक जैसा करते हैं, उनके नाम रखने के लिए एक ही तरीका अपनाइए। उदाहरण के लिए, अगर आप विद्यार्थी का नाम निकालने वाले फंक्शन का नाम getStudentName() रखते हैं, तो विद्यार्थी का ग्रेड निकालने वाले फंक्शन के नाम में कोई दूसरी क्रिया इस्तेमाल न कीजिए (जैसे retrieveStudentGrade())।

एक ही शब्द को दो कामों के लिए इस्तेमाल न कीजिए

उदाहरण के लिए, अगर आप add का इस्तेमाल पहले ही दो संख्याओं को जोड़ने के लिए कर चुके हैं, तो चीज़ों के समूह को किसी कलेक्शन में डालने के लिए उसी add का इस्तेमाल न कीजिए। इसके बजाय insert या append इस्तेमाल कीजिए।