统一写法,问题自然少
在开发一个电商项目时,团队里有人用驼峰命名变量,有人用下划线,接口返回字段一会儿大写一会儿小写。结果前端拼接订单状态时,把 order_status 写成了 orderStatus,导致页面一直显示“未知状态”。这种低级错误,在没有编码标准的项目里太常见了。
一旦团队约定好命名规则、文件结构和注释方式,类似的问题就少了。不是大家粗心,而是缺乏统一的“语言”。就像同事之间说话,你说“冰箱”,他说“冷柜”,来回确认反而浪费时间。
代码看起来顺,查问题也快
有次线上支付失败,日志里一堆 res、data、result 混着用,根本分不清哪个是接口响应,哪个是处理后的数据。翻了半小时才定位到是某个中间层把 success 字段误转成了字符串 "false"。
后来团队引入 ESLint 规则,强制要求响应对象必须命名为 response,业务数据用 payload,加上类型注解。再出问题,一眼就能看出数据在哪一步变了形。
interface ApiResponse {
code: number;
payload: OrderData;
message?: string;
}自动化工具帮你盯细节
手动检查格式不现实。我们配置了 Prettier 自动格式化代码,提交时 Husky 触发 lint 检查。有一次同事少写了异步函数的 await,CI 直接报错拦住,没让这个 bug 流到测试环境。
这些工具不是摆设,它们把人为疏忽挡在上线前。比如禁止使用 any 类型、要求每个函数有返回类型声明,看似麻烦,但能提前发现逻辑漏洞。
新人进组也不用猜“这里为啥这样写”,直接看 .eslintrc 就知道规则。省下的沟通成本,够多写两个接口。