在开发一个用户量上百万的电商系统时,我所在的团队一度陷入混乱。不同人写的代码风格五花八门,函数命名有的用驼峰,有的用下划线,甚至同一个模块里都有好几种写法。结果就是,每次接手别人的代码都像在读天书,查个bug要先花半小时理解逻辑。
统一命名规则不是小事
别小看变量和函数的命名。在一个支付模块里,有人把订单金额写成 order_money,有人叫 amount,还有人用 totalPrice。这种不一致会让后续维护变得异常困难。我们后来统一规定:所有金额字段必须使用 amount,且单位为“分”,避免浮点数精度问题。
目录结构要有清晰逻辑
项目一变大,文件越来越多。如果没有合理的目录划分,找一个接口可能要翻五六层文件夹。我们按功能模块划分主目录,比如 /user、/order、/payment,每个模块内部再分 /service、/controller、/utils。新同事第一天就能快速定位代码位置。
接口返回格式必须标准化
曾经因为前后端对接口格式理解不一致,导致App上线当天首页数据全部显示失败。后来我们定下死规矩:所有接口返回必须包含 code、message 和 data 字段。成功时 code 为0,失败则返回对应错误码。
{
"code": 0,
"message": "success",
"data": {
"userId": 12345,
"userName": "zhangsan"
}
}
注释不是越多越好,但关键处不能少
没人喜欢满屏都是注释的代码,但复杂的业务逻辑必须写清楚。比如退款流程涉及多状态校验,我们在核心判断前加上简短说明:// 需排除已全额退或冻结中的订单。这样下次修改时不会误删关键逻辑。
提交记录也要讲规矩
Git 提交信息不是写“改了点东西”就行。我们要求每条 commit 必须标明类型和影响范围,比如:fix(user): 修复登录态过期跳转问题 或 feat(order): 添加批量取消订单功能。这样回溯问题时能快速定位变更点。
用工具代替人工检查
靠人提醒太累,我们接入了 ESLint + Prettier 自动格式化代码,提交时自动检测。CI 流程中加入代码质量扫描,不符合规范的直接拒绝合并。刚开始有人嫌麻烦,两个月后大家都说“真香”。
大型项目的编码规范,本质上是团队沟通的另一种方式。它不解决技术难题,却能让每个人更高效地合作。当你写的代码别人一眼就能看懂,这才是真正的专业。