You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Web-Dev-For-Beginners/translations/zh-CN/6-space-game/3-moving-elements-around/assignment.md

29 lines
2.0 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 评论你的代码
## 指南
清晰、良好注释的代码对于维护和共享项目至关重要。在本作业中,您将练习专业开发者的一个重要习惯:编写清晰、有帮助的注释,解释代码的目的和功能。
检查你游戏文件夹中的当前 `app.js` 文件,找出为其添加注释和整理代码的方法。代码很容易失控,现在是添加注释的好机会,以确保你拥有可读的代码,便于以后使用。
**你的任务包括:**
- **添加注释**,解释每个主要代码部分的作用
- **文档化函数**,清晰描述其目的和参数
- **将代码组织** 成逻辑模块,并添加部分标题
- **删除** 任何未使用或冗余的代码
- **使用一致的** 变量和函数命名规范
## 评分标准
| 评估标准 | 优秀 | 及格 | 需要改进 |
| -------- | --------- | -------- | ----------------- |
| **代码文档** | `app.js` 代码完全注释,对所有主要部分和函数有清晰、有帮助的解释 | `app.js` 代码有充分注释,对大多数部分有基本说明 | `app.js` 代码注释很少,缺乏清晰的说明 |
| **代码组织** | 代码组织成逻辑模块,有清晰的部分标题和一致的结构 | 代码有一定组织,对相关功能进行了基本分组 | 代码有些杂乱,难以理解 |
| **代码质量** | 所有变量和函数使用描述性名称,无未使用代码,风格一致 | 大部分代码使用良好命名,未使用代码较少 | 变量命名不清晰,含未使用代码,风格不一致 |
---
<!-- CO-OP TRANSLATOR DISCLAIMER START -->
**免责声明**
本文件使用 AI 翻译服务 [Co-op Translator](https://github.com/Azure/co-op-translator) 进行翻译。虽然我们力求准确,但请注意自动翻译可能包含错误或不准确之处。原始语言的文档应被视为权威来源。对于重要信息,建议使用专业人工翻译。我们不对因使用本翻译而产生的任何误解或误释承担责任。
<!-- CO-OP TRANSLATOR DISCLAIMER END -->