2.3 KiB
Comment Your Code
Instructions
Clean, well-documented code na important thing to maintain and share your projects. For this assignment, you go practice one of the most important habits of professional developers: to write clear, helpful comments wey go explain wetin your code dey do and how e dey work.
Make you check your current app.js file for your game folder, find how you go fit comment am and tidy am up. E easy for code to scatter, and now na good chance to add comments to make sure say your code dey readable so you fit use am later.
Your task include:
- Add comments wey go explain wetin each major section of code dey do
- Document functions with clear description of their purpose and parameters
- Organize code into logical blocks with section headers
- Remove any code wey no dey used or wey dey repeat
- Use consistent naming style for variables and functions
Rubric
| Criteria | Exemplary | Adequate | Needs Improvement |
|---|---|---|---|
| Code Documentation | app.js code full with comments wey clear and helpful to explain all major sections and functions |
app.js code get enough comments with basic explanations for most sections |
app.js code no get enough comments and explanations no clear |
| Code Organization | Code organize well into logical blocks with clear section headers and consistent structure | Code get some organization with basic grouping for related functionality | Code disorganized small and e hard to follow |
| Code Quality | All variables and functions get descriptive names, no unused code, dey follow consistent conventions | Most code dey follow good naming practice with small-unused code | Variable names no clear, get unused code, style no consistent |
Disclaimer: Dis document na wetin AI translation service Co-op Translator translate. Even though we dey try make am correct, abeg sabi say automated translation fit get mistakes or no too correct. The original document wey e write for im own language na the correct one. If na important matter, make person wey sabi translate am do am well. We no go take responsibility if person no understand or misunderstand from this translation.