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