आसानी से लिखने वाला कोड कैसे लिखें

नमस्कार, हेब्र!

आपके पास कितनी बार ऐसा हुआ कि आप या आपके सहकर्मी एक-दो वाक्यांशों के साथ अपने स्वयं के कोड का वर्णन नहीं कर सके?

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

जब कोड शब्दों के साथ वर्णन करना कठिन होता है, तो ज्यादातर लोगों को ऐसा करने के लिए कल्पना का उपयोग करना पड़ता है। इस कारण से, मानसिक ऊर्जा बर्बाद हो जाती है और कोड की व्याख्या करने में त्रुटियों का खतरा बढ़ जाता है। विभिन्न लोग अभी भी शब्दों को अपने तरीके से महसूस करेंगे, जिससे कोड पर चर्चा करते समय भ्रम पैदा होगा।

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

अवर्णनीय कोड उदाहरण

आप सोच सकते हैं कि कोड केवल एक लिखित भाषा है। यदि कोड सरल दिखता है, तो इसे आसानी से पढ़ा, वर्णित और समझा जा सकता है। हालांकि, यह हमेशा मामला नहीं होता है।

नीचे दिया गया सामान्य निर्णय यह निर्धारित करता है कि एक वर्ष एक लीप वर्ष है।

(divisibleBy(4) and not divisibleBy(100)) or divisibleBy(400) 

यह सरल कोड है। यह 3 बार फ़ंक्शन को कॉल करता है, जिसमें 3 ऑपरेटर (और, या, नहीं) और घोंसले के शिकार के दो स्तर हैं।

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

शायद "एक वर्ष एक लीप वर्ष है यदि यह 4 से विभाज्य है और 100 से विभाज्य नहीं है, या 400 से विभाज्य है"?

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

वर्णित कोड को फिर से दिखाना

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

"400 वर्ष एक अनूठा मामला है। यदि एक वर्ष 400 से विभाज्य है, तो यह एक लीप वर्ष है। 100 वर्ष एक अनूठा मामला है। यदि एक वर्ष 100 से विभाज्य है, तो यह तब तक एक लीप वर्ष नहीं है जब तक कि यह 400 से विभाज्य न हो। विशेष मामले के लिए प्राथमिकता "400 वर्ष है।" यदि कोई विशेष मामले नहीं हैं, तो यह वर्ष एक लीप वर्ष है, बशर्ते कि यह 4 से विभाजित हो।

यह स्पष्ट लगता है, लेकिन संक्षिप्त नहीं है, इसलिए हम पाठ को थोड़ा छोटा करेंगे:
“यदि वर्ष को 400 से विभाजित किया जाता है, तो यह एक लीप वर्ष है। यदि इसे 100 से विभाजित किया जाता है, तो यह एक सामान्य वर्ष है, लेकिन जब 4 से विभाजित किया जाता है, तो यह एक लीप वर्ष होता है। "

यदि हम इन शब्दों को कोड में बदल देते हैं, तो हमें निम्नलिखित जैसा कुछ मिलता है:

 if divisbleBy(400): return LeapYear elif divisbleBy(100) return NormalYear elif divisbleBy(4): return LeapYear else: return NormalYear 

निष्कर्ष

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

कई संगठनों में, कोड पहले ही स्वीकृति परीक्षणों या उपयोगकर्ता कहानियों में शब्दों में वर्णित किया जाना शुरू हो गया है, जिससे उत्पादकता में सुधार हो सकता है।