代码评审加一张清单 返工少了一半
与其争论风格,不如把最容易被漏掉的缺陷做成逐条核对的动作。
评审会上最常见的情形,是大家对着缩进、命名和括号位置讨论半小时,真正容易出问题的地方反而没人看。原因不复杂:看得见的东西容易被评论,看不见的东西需要主动去找,而人天生不擅长找“不存在的错误”。
清单解决的就是这个盲区。把空值判断、边界条件、超时设置、异常分支这些容易被跳过的点,写成一张可以逐条打勾的表,作者提交前自查一遍,评审者再对照一遍。同一份清单用两次,效果比加一次会议更实在。
规模也要控制。业界经验是单次评审控制在四百行以内、每小时不超过五百行,超过这个量,缺陷发现率明显下降。大改动要拆,拆成能独立说清楚的小块,评审者才有精力真看逻辑。
清单的内容可以归成几类。空值与边界是第一类,包括空集合、首尾元素、除零、越界;时间与时区是第二类,跨天、夏令时、本地时间与时间戳混用;状态与并发是第三类,重复提交、竞态、锁粒度。
资源与错误处理是第四类:连接有没有关、临时文件有没有删、异常吞掉之后有没有留下痕迹。安全是第五类,单独列:输入是否校验、鉴权是否在每个入口都做、密码与令牌有没有进日志。这一类不能靠感觉,要靠条款。
提交说明的写法也值得规定。说清改了什么、为什么这么改、评审者怎么验证,比逐行解释更有用。改动涉及界面时附上前后对比,涉及缺陷时附上复现步骤,评审者省下的时间会转化成更细的阅读。
机器能做的事先交给机器。格式、静态检查、依赖漏洞扫描、单元测试,全部前置到流水线,人只看语义。把人的注意力留给“这段逻辑对不对”“这个分支考虑全了吗”,评审才回到它该干的事。
度量要用趋势,不要用来排名。返工率、缺陷逃逸率、评审平均时长,按季度看变化,用来判断清单是否有效、哪一条该删该加。把指标挂到个人名下,很快就会变成走形式。
落地的关键在克制。清单超过一页没人看,条目超过二十条就会被跳过。从最痛的三五条开始,跑两个月,用缺陷数据决定增删,慢慢长成适合自己项目的那一张。
读者留言 · 3 条
清单确实管用,尤其是边界条件那几条,以前总漏。
一次四百行以内这条建议很实用,大 PR 真的看不进去。
指标别挂个人头上,一排名就变成走过场了。
留言为读者个人观点,不代表本站立场。