首页/开发/Git 与协作速查/在评审中标注 nit 与阻塞项
协作与代码评审75 条

在评审中标注 nit 与阻塞项

用 nit: 前缀标出不阻塞的小建议,用 must/阻塞 明确合入条件;统一用语能减少「到底要不要改」的反复确认。

Git 与协作速查开发更新于 2026-10-13

评审意见为什么要分级

同一份评审里,意见的份量并不相同:有的只是命名或措辞上的偏好,有的却会让线上出错。用统一前缀把两者分开,作者就能立刻知道哪条必须改、哪条可以参考。这套做法在 GitHub、GitLab 等平台上通用,靠的是团队约定,而不是工具特性。

基本信息

nit风格或偏好建议,可改可不改
阻塞项必须修改:正确性、安全、数据兼容问题
建议格式前缀标签 + 理由 + 可行改法
常用标签nit / blocking / question / suggestion
作用范围任意代码评审平台(GitHub、GitLab 等)

典型使用场景

  • 代码整体可用但存在命名、格式细节时,用 nit 一次性说明,不阻塞合并
  • 发现空指针、越界、缺少错误处理等真实缺陷时明确标为阻塞项
  • 对实现意图不清楚时用 question 先确认,再判断是否阻塞
  • 给出改进建议时附一条可直接采纳的写法,降低作者的决策成本
  • 同一个 nit 反复出现时,转为文档约定或自动化检查项

评论示例

评论示例
nit: 这两处可以合并成一个 if,非阻塞
blocking: 该分支缺少错误处理,空输入会 panic,请补充
question: 这个超时值有依据吗,方便的话附上来源
suggestion: 建议用一次遍历加 map,写法更短

评论前缀读法

前缀是否阻塞适用情形
nit否命名、措辞、可选的写法偏好
blocking是正确性、安全、数据兼容性问题
question视回答而定意图不清或需要补充依据
suggestion否有明确更优写法的可选改进
对 nit 集中批量说明,不要在大量小事上逐条阻塞合入,把精力留给高风险问题。评审的目标是提高代码质量,不是让作者按自己的偏好重写一遍。
同一个 nit 在多个 PR 里反复出现,说明它该被固化:写进代码规范文档,或用 linter、格式化工具自动检查,人工提醒会一直重复。

易错点

  • 不给前缀直接提意见,作者无法判断哪条必须改,容易在无关小事上反复往返
  • 把个人偏好写成阻塞项,导致 PR 长期无法合入,评审的信任度下降
  • 只指出问题不给可行改法,作者需要猜测意图,沟通成本反而更高
  • 同一个 nit 反复出现仍靠人工提醒,不沉淀为文档或自动化检查,问题会一直重复

数据来源与参考

  • Google Engineering Practices:How to write code review comments
  • GitHub Docs:Reviewing changes
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌