注释不是摆设,关键时候能救命
刚入职那会儿,我接手了一个老同事留下的项目。打开代码一看,满屏都是函数和变量,没有任何说明。当时正赶上系统出问题,客户急着要结果,我硬是花了两天才理清楚逻辑。后来我才明白,写好注释不是为了别人,其实是救未来的自己。
别再写“这里做了点处理”这种废话
很多人写注释图省事,喜欢打一行“// 这里做了数据处理”。问题是,这跟没写差不多——谁不知道你在处理数据?真正有用的注释得说清楚“为什么这么做”。
比如下面这个例子:
// 避免浮点数精度问题,将金额乘以100转为整数计算
const totalCents = Math.round(amount * 100);
这一句就解释了背后的原因,下一个人看到就不会轻易删掉这行“多余”的转换。
文档里的注释也一样重要
不只是代码,Excel 表格、PPT 汇报材料里加个批注也能省去一堆沟通成本。上周开部门会,财务发来的报表里有一栏突然变了算法,我没问清直接用了,结果汇报时被领导当场纠正。
后来我学乖了,在共享表格里主动加上批注:
【更新说明】2024年起运输成本计入本项,原口径不含物流费用
这样哪怕后续换人接手,也能一眼看出变化节点。
团队协作中的注释习惯
我们组现在写代码都约定一个规则:新功能上线必须附带注释说明使用场景。有一次实习生写了个自动导出脚本,没写任何说明。结果他请假一周,没人敢动那个模块,生怕影响日报发送。
后来我们干脆在 Git 提交模板里加了一栏“变更说明”,强制大家写清楚修改意图。像这样:
【变更原因】修复订单状态不同步问题
【影响范围】支付回调接口、订单查询服务
【注意事项】下游系统需在48小时内完成适配
时间久了发现,这些看似多出来的步骤,反而减少了半夜被叫起来救火的次数。
别等出事才想起注释的价值
前两天听说隔壁部门一个项目延期两周,就因为原始设计文档没人标注关键参数来源,重新核对花了一周。其实只要当初在文件旁加个批注:“UV 数据来自 Google Analytics 主账户”,后面的人根本不用反复确认。
注释的本质是信息传递。你写的每一行说明,都是给未来某个焦头烂额的人递过去的一根绳子。也许那个人,就是下周的你。