代码规范与项目管理

🎯本节学习目标

• 掌握命名规范
• 掌握文件组织
• 掌握版本控制

🚀课程导读

“代码要能给别人看、给三个月后的自己看”。本课建立专业规范。

◆命名与注释规范

“看得懂”的代码。

1. 【变量】驼峰命名：playerHealth、moveSpeed；私有加下划线 _rb、_hp。
2. 【方法】动词开头：Move()、TakeDamage()、LoadLevel()。
3. 【类】大驼峰：PlayerController、GameManager。
4. 【常量】全大写：MAX_HP。
5. 【Unity 特殊】序列化字段 public 或 [SerializeField] private；事件用 On 开头：OnPlayerDied。
6. 【命名意义】别用 a、b、temp 当变量名；用有意义的：enemyHp。
7. 【注释】关键逻辑写“为什么”（别写“做了什么”）：
8. // 用局部变量捕获循环变量，避免闭包问题
9. 【注释时机】复杂算法、边界情况、非直觉逻辑。
10. 【中文/英文】团队统一；教程项目中文注释易读。
11. 【一致性】全项目一个风格（对照已有代码）。
12. 【完成】代码“规范”了！
13. 【推荐】写代码时当“要被同事审查”。

◆文件组织与版本控制

“不乱”的项目。

1. 【文件夹规范】（第 4 章深化）：
2. Assets/Scripts/（Player/Enemy/UI/Managers 子目录）
3. Assets/Prefabs/
4. Assets/Scenes/
5. Assets/Art/（Textures/Materials/Models）
6. Assets/Audio/
7. Assets/Resources/（如用）
8. 【命名文件】与内容一致：PlayerController.cs、Level1.unity。
9. 【Prefab 命名】统一后缀：Enemy_Patrol.prefab、UI_HpBar.prefab。
10. 【场景命名】Level1、MainMenu、GameOver。
11. 【Git 版本控制】
12. 安装 Git → 项目目录 git init。
13. 【.gitignore】Unity 项目忽略：Library/、Temp/、Obj/、Logs/。
14. 【提交】小步提交：做完一个功能 commit 一次，写清 message。
15. 【回滚】出错 git revert/checkout 恢复。
16. 【分支】（进阶）main/develop/feature 分支。
17. 【完成】项目“井井有条”。
18. 【推荐】当天工作当天 commit。
19. 【注意】别把整个项目放云盘当版本控制（Git 才是）。
20. 【工具】GitHub Desktop/Sourcetree 可视化操作。

⚠常见错误与排查

★动手练习

✓本节小结

代码规范完成！下一课继续进阶修炼与发布。