टिप्पणी के माध्यम से विकास प्रतिमान

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

टिप्पणी के माध्यम से विकास प्रतिमान

आइडिया। टिप्पणी-डिजाइन। कोड। (आईसी-डीसी)

विचार: टिप्पणियों के माध्यम से डिजाइन करना। कोड।

• विचार
  विचार के सर्जक आप या कोई अन्य व्यक्ति हो सकते हैं - उदाहरण के लिए, आपके पीएम (टिमलिड)।

एक विचार का उदाहरण: "आपको '+, -, कोष्ठक और रिक्त स्थान' जैसे वर्णों से फ़ोन नंबर साफ़ करने की आवश्यकता है, ताकि आउटपुट केवल संख्याओं का एक सेट हो। फ़ोन नंबर द्वारा किसी खोज को कार्यान्वित करने के लिए एक सुविधा की आवश्यकता है - किसी भी तरह से प्रवेश किया।"

• टिप्पणियों के माध्यम से डिजाइन
  कार्यक्रम के तर्क का वर्णन करने वाली टिप्पणियाँ लिखना।

टिप्पणियों के माध्यम से डिजाइन उदाहरण:

<?php namespace App\Services; use App\Entity\Users; use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManager; class PhoneService { //  ,   //        //    //  ,    8,     7 //   } 

• कोड लेखन
  अब हमें अपने टिप्पणी प्रक्षेपण को कोड में बदलने की आवश्यकता है:

उदाहरण:

 <?php namespace App\Services; use App\Entity\Users; use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManager; class PhoneService { //  ,   public function clear_phone(string $phone){ //        $symbols_for_delete = ['+','-','(',')', ' ']; //    $phone = str_replace($symbols_for_delete, '', $phone); //  ,    8,     7 if( $phone[0] == '8' ){ $phone[0] = '7'; } //   return $phone; } } 

इसके लिए क्या है?

मुझे टिप्पणियों, कोड की आवश्यकता क्यों है, और इसलिए यह स्पष्ट है?

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

मुझे डिजाइन की आवश्यकता क्यों है, क्या मैं एक बार में सब कुछ लिख सकता हूं?

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

कोड डिजाइन चरण में, 75% त्रुटियां आमतौर पर पाई जाती हैं। अगर वे नहीं मिले, तो मुझे रिफ्लेक्टर करना होगा।

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

क्या मुझे हर चीज पर टिप्पणी करने की जरूरत है?

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