15 KiB

Raw Blame History

कोड पुनःसंरचना र दस्तावेजीकरण असाइनमेन्ट

सिकाइ उद्देश्यहरू

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

सफा, राम्रोसँग दस्तावेजीकृत कोड वास्तविक संसारको वेब विकास परियोजनाहरूको लागि महत्त्वपूर्ण छ जहाँ धेरै विकासकर्ताहरूले सहकार्य गर्छन् र कोडबेस समयसँगै विकसित हुन्छ।

असाइनमेन्टको अवलोकन

तपाईंको बैंकिङ एपको app.js फाइलले लगइन, दर्ता, र ड्यासबोर्ड कार्यक्षमतासँग धेरै विस्तार गरेको छ। यो कोडलाई पढ्न सजिलो, मर्मतयोग्य बनाउन र दोहोर्याइ घटाउन पेशेवर विकास अभ्यासहरू प्रयोग गरेर पुनःसंरचना गर्ने समय हो।

निर्देशनहरू

तपाईंको हालको app.js कोडलाई यी तीन मुख्य पुनःसंरचना प्रविधिहरू कार्यान्वयन गरेर परिवर्तन गर्नुहोस्:

१. कन्फिगरेसन स्थिरांकहरू निकाल्नुहोस्

कार्य: पुनः प्रयोग गर्न मिल्ने स्थिरांकहरूसँग फाइलको माथि कन्फिगरेसन खण्ड बनाउनुहोस्।

कार्यान्वयन मार्गदर्शन:

सर्भर API बेस URL (हाल धेरै ठाउँमा हार्डकोड गरिएको) निकाल्नुहोस्
धेरै कार्यहरूमा देखिने त्रुटि सन्देशहरूको लागि स्थिरांकहरू बनाउनुहोस्
बारम्बार प्रयोग गरिएका रूट पथहरू र एलिमेन्ट ID हरू निकाल्ने विचार गर्नुहोस्

उदाहरण संरचना:

// Configuration constants
const API_BASE_URL = 'http://localhost:5000/api';
const ROUTES = {
  LOGIN: '/login',
  DASHBOARD: '/dashboard'
};

२. एकीकृत अनुरोध कार्य बनाउनुहोस्

कार्य: पुनः प्रयोग गर्न मिल्ने sendRequest() कार्य बनाउनुहोस् जसले createAccount() र getAccount() बीचको दोहोर्याइएको कोडलाई हटाउँछ।

आवश्यकताहरू:

GET र POST अनुरोधहरू दुवैलाई ह्यान्डल गर्नुहोस्
उचित त्रुटि ह्यान्डलिङ समावेश गर्नुहोस्
विभिन्न URL अन्त बिन्दुहरूलाई समर्थन गर्नुहोस्
वैकल्पिक अनुरोध बडी डाटा स्वीकार गर्नुहोस्

कार्यको हस्ताक्षर मार्गदर्शन:

async function sendRequest(endpoint, method = 'GET', data = null) {
  // Your implementation here
}

३. पेशेवर कोड दस्तावेजीकरण थप्नुहोस्

कार्य: तपाईंको कोडलाई स्पष्ट, उपयोगी टिप्पणीहरूसँग दस्तावेजीकरण गर्नुहोस् जसले तपाईंको तर्कको "किन" व्याख्या गर्दछ।

दस्तावेजीकरण मापदण्डहरू:

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

उदाहरण दस्तावेजीकरण शैली:

/**
 * Authenticates user and redirects to dashboard
 * @param {Event} event - Form submission event
 * @returns {Promise<void>} - Resolves when login process completes
 */
async function login(event) {
  // Prevent default form submission to handle with JavaScript
  event.preventDefault();
  
  // Your implementation...
}

सफलता मापदण्ड

तपाईंको पुनःसंरचित कोडले यी पेशेवर विकास अभ्यासहरू प्रदर्शन गर्नुपर्छ:

उत्कृष्ट कार्यान्वयन

✅ स्थिरांकहरू: सबै जादुई स्ट्रिङहरू र URL हरू स्पष्ट रूपमा नामित स्थिरांकहरूमा निकालिएका छन्
✅ DRY सिद्धान्त: सामान्य अनुरोध तर्कलाई पुनः प्रयोग गर्न मिल्ने sendRequest() कार्यमा समेकित गरिएको छ
✅ दस्तावेजीकरण: कार्यहरूमा स्पष्ट JSDoc टिप्पणीहरू छन् जसले उद्देश्य र प्यारामिटरहरू व्याख्या गर्छ
✅ संगठन: कोड स्पष्ट रूपमा समूह गरिएको छ खण्ड शीर्षकहरू र सुसंगत ढाँचासँग
✅ त्रुटि ह्यान्डलिङ: नयाँ अनुरोध कार्य प्रयोग गरेर सुधारिएको त्रुटि ह्यान्डलिङ

पर्याप्त कार्यान्वयन

✅ स्थिरांकहरू: धेरै दोहोरिएका मानहरू निकालिएका छन्, केही हार्डकोड गरिएको मानहरू बाँकी छन्
✅ फ्याक्टराइजेसन: आधारभूत sendRequest() कार्य बनाइएको छ तर सबै किनाराका केसहरू ह्यान्डल गर्न सक्दैन
✅ टिप्पणीहरू: मुख्य कार्यहरू दस्तावेजीकृत छन्, यद्यपि केही व्याख्याहरू अझ पूर्ण हुन सक्छन्
✅ पढ्न सजिलो: कोड सामान्यतया राम्रोसँग व्यवस्थित छ केही सुधारको क्षेत्रहरूका साथ

सुधार आवश्यक छ

❌ स्थिरांकहरू: धेरै जादुई स्ट्रिङहरू र URL हरू फाइलभरि हार्डकोड गरिएको छ
❌ दोहोर्याइ: समान कार्यहरू बीच महत्वपूर्ण कोड दोहोर्याइ बाँकी छ
❌ दस्तावेजीकरण: कार्यको उद्देश्य व्याख्या नगर्ने वा अपर्याप्त टिप्पणीहरू
❌ संगठन: कोडमा स्पष्ट संरचना र तार्किक समूह अभाव छ

तपाईंको पुनःसंरचित कोड परीक्षण गर्नुहोस्

पुनःसंरचना पछि, सुनिश्चित गर्नुहोस् कि तपाईंको बैंकिङ एप अझै सही रूपमा काम गर्छ:

सबै प्रयोगकर्ता प्रवाहहरू परीक्षण गर्नुहोस्: दर्ता, लगइन, ड्यासबोर्ड प्रदर्शन, र त्रुटि ह्यान्डलिङ
API कलहरू प्रमाणित गर्नुहोस्: तपाईंको sendRequest() कार्यले खाता सिर्जना र पुनःप्राप्ति दुवैका लागि काम गर्छ भन्ने सुनिश्चित गर्नुहोस्
त्रुटि परिदृश्यहरू जाँच गर्नुहोस्: अमान्य प्रमाणहरू र नेटवर्क त्रुटिहरूको साथ परीक्षण गर्नुहोस्
कन्सोल आउटपुट समीक्षा गर्नुहोस्: पुनःसंरचनाको क्रममा कुनै नयाँ त्रुटिहरू परिचय नगरिएको सुनिश्चित गर्नुहोस्

पेश गर्ने दिशानिर्देशहरू

तपाईंको पुनःसंरचित app.js फाइल पेश गर्नुहोस्:

विभिन्न कार्यक्षमताहरूलाई व्यवस्थित गर्ने स्पष्ट खण्ड शीर्षकहरू
सुसंगत कोड ढाँचा र इनडेन्टेसन
सबै कार्यहरूको लागि पूर्ण JSDoc दस्तावेजीकरण
माथि छोटो टिप्पणी जसले तपाईंको पुनःसंरचना दृष्टिकोण व्याख्या गर्छ

बोनस चुनौती: एउटा साधारण कोड दस्तावेजीकरण फाइल (CODE_STRUCTURE.md) बनाउनुहोस् जसले तपाईंको एपको वास्तुकला र विभिन्न कार्यहरू कसरी सँगै काम गर्छ भन्ने व्याख्या गर्छ।

वास्तविक संसारको सम्बन्ध

यो असाइनमेन्टले पेशेवर विकासकर्ताहरूले नियमित रूपमा गर्ने प्रकारको कोड मर्मतलाई प्रतिबिम्बित गर्छ। उद्योग सेटिङहरूमा:

कोड समीक्षा पढ्न सजिलो र मर्मतयोग्यताको मूल्याङ्कन गर्छ जस्तै यो असाइनमेन्ट
प्राविधिक ऋण संचित हुन्छ जब कोड नियमित रूपमा पुनःसंरचना र दस्तावेजीकृत गरिँदैन
टीम सहकार्य स्पष्ट, राम्रोसँग दस्तावेजीकृत कोडमा निर्भर गर्दछ जुन नयाँ टोली सदस्यहरूले बुझ्न सक्छन्
बग सुधारहरू राम्रोसँग व्यवस्थित कोडबेसहरूमा उचित अमूर्ततासँग धेरै सजिलो हुन्छ

तपाईंले यहाँ अभ्यास गरिरहनुभएको सीपहरू - स्थिरांकहरू निकाल्ने, दोहोर्याइ हटाउने, र स्पष्ट दस्तावेजीकरण लेख्ने - पेशेवर सफ्टवेयर विकासको लागि आधारभूत छन्।

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

15 KiB Raw Blame History