代码评审黑话词典:LGTM 的十种语气
代码评审区是现代职场里最含蓄的文学现场。大家嘴上说的是“看起来不错”,心里想的是“这也能上线”;嘴上写的是“有个小建议”,手上已经把这条标成了 blocking。
更麻烦的是,这些话往往没有上下文。同样是 LGTM,可能是真心夸奖,也可能是“我没看”,还可能是“我看了,但我不想成为责任人”。下面这份词典,不能保证你升职加薪,但至少能让你在下次评审时少猜一会儿。
一、LGTM 的十种语气
| 评审原话 | 字面意思 | 常见真实含义 | 建议动作 |
|---|---|---|---|
| LGTM | 看起来不错 | 我看了,没发现问题 / 我没看 | 看对方是否留了其他评论 |
| LGTM,不过有个小问题 | 总体不错 | 有个必须改的问题 | 当成 blocking 处理 |
| nit: | 吹毛求疵 | 我不好意思直说,但希望你改 | 改起来便宜就改 |
| 这里是不是可以…… | 疑问句 | 请按我说的改 | 先讨论,再动手 |
| 我有个不成熟的小建议 | 谦虚 | 成熟且强烈 | 认真对待 |
| 先合了再说 | 先合并 | 我知道会炸,但不想现在炸 | 立刻补 issue |
| 这个我们之前讨论过 | 讨论过 | 我忘了结论,但气氛要拿捏 | 翻聊天记录和文档 |
| 你确定吗? | 询问 | 你错了 | 先自查,再回复 |
| 后面再优化 | 以后再说 | 永远不会 | 现在写 TODO 和截止日期 |
| 代码风格问题 | 风格 | 有人要开战了 | 交给格式化工具 |
这张表最重要的不是“翻译”,而是最后那列。评审意见没有动作,就等于没有意见;而被评审的人如果不追问动作,最后只能靠猜。
二、nit 是一面盾牌
nit: 是评审区里最常被滥用的前缀。它的本意是“nitpick”,即无关紧要的挑剔,相当于提前声明“这条不阻塞合并”。但在实际使用中,它经常被拿来包装一些其实很阻塞的问题:
1- if (user != null && user.id != null) {
2+ // nit: 这里是不是可以提前 return?
3+ if (user == null || user.id == null) {
4+ return;
5+ }这条评论写的是 nit,改的却是控制流。它可能让一个本来能跑的分支提前退出,也可能让后面的逻辑少一层缩进。说它是“小问题”,多少有点谦虚过头。
比较诚实的写法是直接标注意图。业界已经有一套轻量的约定,叫 Conventional Comments,用标签加修饰词表达“这条到底阻不阻塞”:
1nitpick (non-blocking): 这里的变量名 payload 太泛,叫 retryPayload 会更清楚。
2suggestion (blocking): 这个请求没有超时,建议补上 timeout,否则线程会一直挂着。
3question: 这里的 3 是重试次数还是超时秒数?建议换成常量。
4issue: 用户名为空时会抛 NPE,需要在入口处校验。关键不在格式多漂亮,而在于三件事:这条是不是必须改、为什么、改成什么。只写“这里不太好”,等于把难题原样退回给作者。
三、代码里的暗语比评论更诚实
有时候评审意见写得很客气,代码本身却在喊救命。比如这种“临时兼容”:
1def parse_config(path):
2 # TODO: 2021-03-01 之前删掉
3 if path.endswith(".old.json"):
4 return legacy_parse(path)
5 return json.loads(open(path).read())看到 TODO 带日期,先别感动。打开 git blame 看一眼,大概率会发现那个日期已经过去好几年了。日期不是承诺,是墓碑。
再看一种经典写法:
1// 不要动,动了会出问题
2if (retryCount === 3) {
3 retryCount = 0;
4}这条注释的信息量约等于“前面有坑”。它没有说清是什么问题、在什么条件下复现、动了之后谁负责。真正有用的注释应该写成这样:
1// 服务端在连续 3 次失败后会锁账号 10 分钟,
2// 因此这里重置计数,避免第 4 次请求触发风控。
3// 相关讨论见 issue #482。
4if (retryCount === 3) {
5 retryCount = 0;
6}差别不在于字数,而在于下一个人能不能判断“现在还需不需要这条逻辑”。
四、把黑话翻译成需求
评审里最消耗人的,不是改代码,而是把一句模糊的话翻译成可执行的任务。可以试试这个三步法:
- 先问阻塞性:这条是必须改,还是可以另开 issue?
- 再问验收标准:改成什么样算通过?有没有测试能证明?
- 最后问责任人:现在改,还是记下来以后改?以后是哪一天?
对应到回复上,也有一个简单模板:
1收到。确认一下:
21. 这条是 blocking 吗?
32. 我理解是要在入口处校验 user.id 非空,并补一个单测,对吗?
43. 如果今天先合并,我开一个 issue 跟进,可以吗?这段话不卑不亢,也不显得敷衍。它把“你觉得呢”变成了“我这样理解,对不对”。
五、给评审者的三条自律
第一,能交给工具的就别交给嘴。 缩进、引号、行宽、import 顺序,这些争论一次就够了。Python 用 black,Go 用 gofmt,Rust 用 rustfmt,前端用 Prettier,再配一个 CI 检查。工具不会记仇,也不会在群里说“上次也是你”。
第二,一次评审只抓主要矛盾。 一个 PR 里留四十条 nit,作者只会记住“这个人在针对我”。真正重要的是正确性、边界条件、并发和错误处理,剩下的可以合并后再清理。
第三,夸人要具体。 “LGTM”是礼貌,“这里的错误处理把重试和超时分开,读起来很清楚”才是反馈。前者让人放心,后者让人进步。
六、给作者的一条底线
如果你是被评审的那一方,请把 PR 写小一点。一个三千行的 PR,评审者能给出的最深评价通常只有两种:“看起来不错”和“我再看看”。这不是他们不专业,是人类的注意力就这么多。
把改动拆成“纯重构”和“行为变更”两个 PR,把背景写在描述里,把验证命令贴出来:
1# 本地验证
2pytest tests/test_config.py -q
3curl -s localhost:8000/health | jq .这些动作不性感,但能显著减少“这里为什么这么改”的回合数。
最后记住一条:评审意见不是判决书,是一次异步对话。LGTM 可能意味着“很好”,也可能意味着“别找我”。真正的专业,不是学会猜,而是把话说清楚,让对方不用猜。
毕竟,代码可以重构,沟通成本只能提前支付。
参考文档
本文由 AI 辅助生成并经人工校验,如有疏漏欢迎指正。