代码命名指南
场景
同一代码库里同时出现 data、info、obj 和含义不明的缩写时,开发者必须反复跳转才能理解业务,评审也会把时间浪费在猜测上。
原理
命名的本质是建立领域概念到代码符号的稳定映射。类和接口通常使用大驼峰,方法与变量使用小驼峰,常量使用大写蛇形,URL 与文件常用短横线。规范只是外形,更关键的是名称能表达职责、单位、状态与副作用。
设计步骤
先维护团队统一的领域词汇;为布尔值采用 is/has/can,集合使用复数,时间和金额带上单位或币种;方法名用动词说明行为,查询与命令避免混淆;发现名称需要注释解释时,优先缩小作用域或重新抽象。
权衡
长名称信息充分但阅读噪声更大,短名称简洁却依赖上下文。局部循环变量可以短,公共 API 必须明确。统一风格有价值,但批量改名会制造巨大 diff,因此应结合功能修改分步推进。
实践建议
禁用无业务含义的 Manager、Handler 滥用;不要把类型重复写进变量名;缩写只保留 HTTP、ID 等团队共识。借助 IDE 安全重命名并运行测试,接口字段改名则提供兼容期。好的名字应让调用处像一句可验证的业务陈述。
落地检查
上线前还应做一次桌面演练:准备正常、边界、超时、重复与恶意输入,确认系统的返回、日志和指标彼此对应;在预发布环境模拟依赖不可用、进程重启和配置回滚,验证降级路径不会放大故障。上线时采用小流量观察,提前定义停止条件与负责人。稳定后复盘真实数据,删除没有收益的复杂度,并把新发现的约束补进测试、监控和设计记录,使方案能够随业务持续演进,而不是停留在一次性评审结论。
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 Dai Wei!
评论

