首页/ 第 6 章 · 游戏对象与组件交互/ 第 87 课
LESSON 87 · 游戏对象与组件交互

命名与代码规范实战

代码规范已落地。下一课学 MonoBehaviour 消息 OnEnable/OnDisable 的妙用。

⏱ 约 13 分钟📊 难度:入门🗂 第 6 章 · 游戏对象与组件交互📍 第 87 / 300 课
课程进度
87 / 300

🎯本节学习目标

  • 掌握命名与注释规范
  • 理解职责单一原则
  • 写出可维护的代码

🚀课程导读

代码是写给“未来的自己”看的。本课把规范真正用起来,让你的脚本专业、易维护。

命名规范落地

一眼看懂每个名字。

  1. 【类/方法】大驼峰:PlayerController、StartMove、TakeDamage。
  2. 【字段/变量】小驼峰:playerSpeed、maxHp、isDead。
  3. 【常量】全大写:MAX_HP、GRAVITY。
  4. 【私有字段前缀】_ 开头(如 _hp)区分公有:private int _hp;(社区常用下划线风格)。
  5. 【布尔变量】is/ has/ can 前缀表状态:isDead、hasKey、canJump。
  6. 【禁止】不缩写到看不懂(btn 可,bt 不行);不用拼音;不同语言混用。
  7. 【Unity 字段】public 的序列化字段名清晰表达用途:moveSpeed、damagePerHit。
💡
好名字胜过注释:moveSpeed 比 spd 或“速度”更好。

注释与职责单一

让代码“自解释”+“小而专”。

  1. 【注释规范】说明“为什么”而非“是什么”:// 用 Lerp 平滑跟随,避免瞬移
  2. 【块注释】类顶部写类的作用:/// <summary> 控制玩家移动 </summary>
  3. 【职责单一】一个脚本只做一件事:PlayerMove 管移动、PlayerHealth 管血量、PlayerAttack 管攻击,别大杂烩。
  4. 【方法小而精】一个方法只做一件事;过长拆分成子方法。
  5. 【去魔法数字】用常量/字段代替写死的数字:const int MAX_HP = 100。
  6. 【及时重构】代码重复出现两次以上就提取成方法/类。
  7. 【删除无用代码】注释掉的死代码直接删,Git 会记住历史。
  8. 【规范收尾】写完跑一遍确认无警告;把调试 Log 清理或保留有用的。
专业标准:脚本“小而专”、命名“自解释”、注释“说原因”、重复“必提取”。

常见错误与排查

错误:代码能跑但以后看不懂?
原因:缺规范与注释
解决:从下一课起,所有新脚本都按本课规范书写,逐步养成习惯。

动手练习

课后小任务(做出来才算真的学会)

  • 把之前写的脚本按本课规范重命名与整理
  • 给类和方法补充 XML 注释
  • 把一个大方法拆成两个职责单一的方法

本节小结

代码规范已落地。下一课学 MonoBehaviour 消息 OnEnable/OnDisable 的妙用。

完成打卡后,主站会实时更新你的学习进度 🎯

← 上一课单例模式 Singleton