5.7 KiB
अपनी कोड पर टिप्पणी करें
निर्देश
साफ़, अच्छे से टिप्पणीकृत कोड आपके प्रोजेक्ट को बनाए रखने और साझा करने के लिए आवश्यक है। इस असाइनमेंट में, आप पेशेवर डेवलपर्स की सबसे महत्वपूर्ण आदतों में से एक का अभ्यास करेंगे: स्पष्ट, सहायक टिप्पणियाँ लिखना जो आपकी कोड के उद्देश्य और कार्यप्रणाली को समझाती हैं।
अपने गेम फ़ोल्डर में मौजूदा app.js फ़ाइल पर जाएं और उसे टिप्पणी करने और व्यवस्थित करने के तरीके खोजें। कोड का नियंत्रण से बाहर होना बहुत आसान है, और अब टिप्पणी जोड़ने का एक अच्छा मौका है ताकि आपके पास पढ़ने में आसान कोड हो जिसे आप बाद में उपयोग कर सकें।
आपका कार्य शामिल है:
- टिप्पणियाँ जोड़ें जो समझाएँ कि कोड का प्रत्येक मुख्य भाग क्या करता है
- फ़ंक्शनों का दस्तावेजीकरण करें उनके उद्देश्य और पैरामीटर के स्पष्ट विवरण के साथ
- कोड को व्यवस्थित करें तार्किक ब्लॉकों में सेक्शन हेडर के साथ
- अप्रयुक्त या अनावश्यक कोड निकालें
- चर और फ़ंक्शन के नामकरण नियमों में सुसंगतता बनाए रखें
मूल्यांकन मानदंड
| मापदण्ड | उत्कृष्ट | उचित | सुधार की आवश्यकता |
|---|---|---|---|
| कोड दस्तावेजीकरण | app.js कोड पूरी तरह से टिप्पणीकृत है जिसमें सभी मुख्य खंडों और फ़ंक्शनों के लिए स्पष्ट और सहायक व्याख्याएँ हैं |
app.js कोड को अधिकांश खंडों के लिए बुनियादी व्याख्याओं के साथ पर्याप्त रूप से टिप्पणीकृत किया गया है |
app.js कोड में न्यूनतम टिप्पणियाँ हैं और स्पष्ट व्याख्या की कमी है |
| कोड संगठन | कोड तार्किक ब्लॉकों में स्पष्ट सेक्शन हेडरों और सुसंगत संरचना के साथ व्यवस्थित है | कोड में कुछ संगठन है जिसमें संबंधित कार्यक्षमता के मूलभूत समूह हैं | कोड कुछ हद तक अव्यवस्थित और अनुसरण करने में कठिन है |
| कोड गुणवत्ता | सभी चर और फ़ंक्शन वर्णनात्मक नामों का उपयोग करते हैं, कोई अप्रयुक्त कोड नहीं, सुसंगत नियमों का पालन करते हैं | अधिकांश कोड अच्छे नामकरण प्रथाओं का पालन करते हैं, न्यूनतम अप्रयुक्त कोड के साथ | चर नाम अस्पष्ट हैं, अप्रयुक्त कोड शामिल है, असंगत शैली |
अस्वीकरण: यह दस्तावेज़ AI अनुवाद सेवा Co-op Translator का उपयोग करके अनुवादित किया गया है। जबकि हम सटीकता के लिए प्रयास करते हैं, कृपया ध्यान रखें कि स्वचालित अनुवादों में त्रुटियाँ या अशुद्धियाँ हो सकती हैं। मूल दस्तावेज़ को उसके स्वदेशी भाषा में प्राधिकार स्रोत माना जाना चाहिए। महत्वपूर्ण जानकारी के लिए, पेशेवर मानव अनुवाद की सलाह दी जाती है। इस अनुवाद के उपयोग से उत्पन्न किसी भी गलतफहमी या गलत व्याख्या के लिए हम उत्तरदायी नहीं हैं।