Code Style

自动关联目录:Code Style

代码风格的意义不在于好看,而在于让差异变得显眼:当所有人写法一致时,评审时唯一凸显出来的就是"这段代码真的做了不一样的事"。

命名

对象约定例子
类型 / 类大驼峰AbilitySystemComponent
函数大驼峰(UE)/ 小驼峰(Google)TryActivateAbility
变量小驼峰cooldownRemaining
常量k 前缀或全大写kMaxStacks / MAX_STACKS
布尔b 前缀或 is/hasbIsActive / hasTag
枚举值带类型前缀EAbilityState::Active

规则本身不重要,一致最重要。跨项目时先跟项目现有风格,再谈个人偏好。

函数

  • 短:一个屏幕放得下为佳
  • 一件事:能用"且"描述它在做什么,就该拆
  • 参数 ≤ 3 个:再多就封装成结构体
  • 提前返回代替嵌套 if,减少一层缩进
  • 不改参数当返回值(输出参数容易看漏),除非性能要求

注释

该写不该写
为什么(意图、约束、踩过的坑)是什么(代码已经说了)
不直观的取舍复述函数名
外部依赖的隐含假设废弃代码注释掉
// 错误:注释复述代码
i += 1;  // i 加 1

// 正确:说明原因
// 这里不能提前 break:剩余元素需要走一遍清理逻辑
for (...)

可读性技巧

  • 卫语句:把异常路径先返回,主流程保持在最外层
  • 不要用魔法数字:Cooldown > 0.25f → Cooldown > kMinVisibleCooldown
  • 布尔表达式读起来像句子:if (IsValid(Target) && HasEnoughMana())
  • 限制作用域:变量用到再声明,别在开头全声明完
  • 一致的错误处理:要么返回错误码,要么抛异常,别混着来

工程层面

实践原因
格式化交给工具(clang-format / prettier)评审不再讨论空格
开启并清零警告警告是会变错误的债
提交前自查 diff90% 的问题在提交前就能自己发现
单个提交只做一件事出问题时能精确定位、能安全回滚

参考