首页/开发/代码质量与评审速查/评审检查项:命名与可读性
代码评审64 条

评审检查项:命名与可读性

命名检查:名称是否表达意图与领域含义、是否与代码库既有术语一致、名称长度与作用域是否匹配、控制流是否一眼可读。

  • 名称说明是什么或做什么,而不是怎么实现
  • 与领域术语、既有 API 命名保持一致
  • 短作用域可用短名,长作用域需要更描述性的名称
  • 可读性:清晰的直白写法优于炫技写法
命名分歧别升级为品味之争:以'未来读者能否快速理解'为准绳。
自检法:遮住定义只看调用处,能否推断参数与返回值含义;需要跳转查看才知道时,名称还需要更明确。

易错点

  • 用缩写堆砌名称(如 gtUsrIdx):后来人必须反查含义
  • 重构后名称未同步:名实不符比难读更危险

数据来源与参考

  • Google Engineering Practices · What to look for in a code review(Naming)
  • 《Clean Code》命名章节
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌