🤱🏻 🙎🏿 🐧 7 जावास्क्रिप्ट कोड दिशानिर्देश 🌝 🚇 🧔🏼

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

1. अनुकूल चर और फ़ंक्शन नामों का उपयोग करें

कोड को पढ़ने में बहुत आसान है जब यह फ़ंक्शन और चर के स्पष्ट, वर्णनात्मक नामों का उपयोग करके लिखा जाता है। यहाँ वह कोड है जो बहुत स्पष्ट नहीं है:

function avg (a) {  let s = a.reduce((x, y) => x + y)  return s / a.length }

यदि आप चर और कार्यों के अनुकूल नामों का उपयोग करते हैं तो उनके पठनीयता में काफी सुधार होगा।

 function averageArray (array) { let sum = array.reduce((number, currentSum) => number + currentSum) return sum / array.length }

कार्यक्रम के पाठ लिखते समय अतिसूक्ष्मवाद के लिए प्रयास न करें। पूर्ण चर नामों का उपयोग करें जो कोई भी भविष्य में आपके कोड के साथ काम करेगा वह आसानी से समझ सकता है।

2. छोटे कार्य लिखें जो एक समस्या को हल करते हैं

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

 function sumAndAverageArray(array) { let sum = array.reduce((number, currentSum) => number + currentSum) return sum / array.length }

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

 function sumArray(array) { return array.reduce((number, currentSum) => number + currentSum) } function averageArray(array) { return sumArray(array) / array.length }

एक संकेत जो फ़ंक्शन को दो में विभाजित किया जा सकता है, उसके नाम में शब्द "और" का उपयोग करने की संभावना है।

3. कोड दस्तावेज़

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

 function areaOfCircle (radius) { return 3.14 * radius ** 2 }

आप इस कोड को किसी ऐसे व्यक्ति के लिए अधिक समझने योग्य बना सकते हैं, जो किसी वृत्त के क्षेत्र की गणना करने के सूत्र को नहीं जानता है।

 const PI = 3.14 //  ,       function areaOfCircle (radius) { //       : //        return PI * radius ** 2 }

यह कोड एक उदाहरण मात्र है। संभवतः, इस स्थिति में, अपने स्वयं के निरंतर पीआई नंबर को जमा करने के बजाय, मानक Math.PI संपत्ति का उपयोग करना बेहतर होगा।

कोड पर टिप्पणियाँ प्रश्न का उत्तर "क्यों" देना चाहिए।

कृपया ध्यान दें कि कोड के दस्तावेजीकरण के उद्देश्य से, यह विशेष टूल और संबंधित कोड टिप्पणी नियमों का उपयोग करने के लिए समझ में आता है। जब पायथन पर लागू किया जाता है, तो मुझे Google स्टाइल डॉकस्ट्रिंग्स पसंद है, जब जावास्क्रिप्ट पर लागू होता है, तो मुझे JSDoc पसंद है ।

4. सैंडी मेट्ज़ नियमों का उपयोग करने के बारे में सोचें

सैंडी मेट्ज़ एक महान रूबी प्रोग्रामर है, दिलचस्प प्रस्तुतियां देता है और किताबें लिखता है। उसने वस्तु-उन्मुख भाषाओं में स्वच्छ कोड लिखने के लिए चार नियम बनाए। यहाँ वे हैं।

कक्षाएं कोड की 100 लाइनों से अधिक नहीं होनी चाहिए।
विधियों और कार्यों को कोड की 5 लाइनों से अधिक नहीं होना चाहिए।
तरीकों को 4 से अधिक मापदंडों से नहीं गुजरना चाहिए।
नियंत्रक केवल एक वस्तु को इनिशियलाइज़ कर सकते हैं।

मैं इन नियमों के संबंध में उनके प्रदर्शन को देखने की सलाह देता हूं।

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

कृपया ध्यान दें कि ये नियम केवल सिफारिशें हैं, लेकिन इनका उपयोग करने से आपका कोड बहुत बेहतर हो जाएगा।

5. चयनित नियमों को क्रमिक रूप से लागू करें

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

मैं कोड शैली गाइड और लिंटर को लागू करने की सलाह देता हूं, जो आपको चयनित मानक पर कोड लाने की अनुमति देता है। उदाहरण के लिए, जावास्क्रिप्ट के लिए मुझे मानक जेएस के नियम पसंद हैं, अजगर के लिए मुझे पीईपी 8 के नियम पसंद हैं।

वास्तव में, यहां मुख्य बात यह है कि कोड डिजाइन नियमों को खोजना और उनका पालन करना।

6. DRY सिद्धांत को याद रखें

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

हालाँकि, यदि आप DRY सिद्धांत को कट्टरता से लागू करने का निर्णय लेते हैं या खराब तरीके से चयनित टेम्प्लेटों को दूर करने का निर्णय लेते हैं, तो कोड की पठनीयता गंभीर रूप से बिगड़ सकती है, और बाद में, आपको अधिक बार समान संरचनाओं की प्रतियां बनाने का सहारा लेना पड़ सकता है। वैसे, रेती मेट्ज़, एक महान लेख है कि कैसे कोड डुप्लिकेट एक असफल अमूर्त की तुलना में कम बुराई है।

परिणामस्वरूप, यह दोहराने के लायक नहीं है, लेकिन यह भी इसके लायक नहीं है, DRY सिद्धांत का पालन करने के लिए संघर्ष में, कोड को इस हद तक संशोधित करना कि यह समझना मुश्किल हो जाए।

7. एनकैप्सुलेशन और मॉड्यूलरिटी के विचारों का उपयोग करें।

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

 let name = 'Ali' let age = 24 let job = 'Software Engineer' let getBio = (name, age, job) => `${name} is a ${age} year-old ${job}`

यदि इस तरह के कार्यक्रम में कई लोगों के डेटा को संसाधित करना आवश्यक है, तो इसमें निम्न निर्माण जैसी किसी चीज़ का उपयोग करना बेहतर होगा।

 class Person { constructor (name, age, job) {   this.name = name   this.age = age   this.job = job } getBio () {   return `${this.name} is a ${this.age} year-old ${this.job}` } }

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

 const ali = { name: 'Ali', age: 24, job: 'Software Engineer', getBio: function () {   return `${this.name} is a ${this.age} year-old ${this.job}` } }

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

परिणाम

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

प्रिय पाठकों! आप अपने कोड के लिए किन नियमों का पालन करते हैं?

7 जावास्क्रिप्ट कोड दिशानिर्देश