首页/开发/代码质量与评审速查/nit 前缀:标注小问题的惯例
代码评审64 条

nit 前缀:标注小问题的惯例

Google 评审惯例:用 Nit: 前缀标注不影响正确性的小问题,让作者能区分'必须改'与'可改可不改',主次一目了然。

nit 前缀是什么

Google 评审惯例用 Nit: 前缀标注不影响正确性的小问题:措辞、格式、微小的可读性改进。有了这个前缀,作者一眼就能分出哪些必须改、哪些可以不改,评审意见的主次随之清晰,也不必为细节反复往返。

基本信息

惯例Nit: 小问题、非阻塞
适用措辞、格式、微小的可读性改进
同类写法Optional、FYI、non-blocking(团队内需统一约定)
依赖条件任意评审工具都可用,纯文本约定,不需要平台支持

使用规则

  • Nit 表示不阻塞:作者可以接受,也可以用理由说明后选择不改。
  • 不带前缀的评论通常被理解为需要处理,别把真问题藏在 nit 里。
  • 前缀要一致:团队约定后写进评审协议,避免各自发明新词。
  • 一次给多条 nit 时集中列出,别让作者在几十条评论里找阻塞项。
  • 同一处反复出现的 nit 值得升级处理:交给工具或写进规范,而不是每次人工提醒。
  • 同一条 nit 被多人重复提出时合并成一条,避免作者重复劳动。
  • 统一前缀写法(都用 Nit: 而不是 NIT、nit — 混着来),能减少作者理解成本。
  • 在评审总结里汇总 nit 清单:作者可以一次处理完,不必在评论里逐条翻找。

写法示例

写法示例
# 非阻塞的小建议
Nit: 这个变量名可以更长一点,比如 retryLimit,读起来更直白。

# 团队约定的其他前缀
Optional: 这里可以补一个请求 ID,不加也能跑。
FYI: 同目录已有实现可以复用,这次不改也没问题。

# 对比:需要处理的意见不用前缀
这里缺少超时,外部依赖挂起时线程会被占满,必须加上。

前缀与含义对照

前缀含义是否需要处理
Nit小问题,非阻塞可改可不改
Optional可选改进作者判断
FYI知会信息无需行动
(无前缀)视为需要处理的意见应回应或修改
前缀是为了省沟通成本:让作者一眼分清主次,而不是降低评审标准。
把实质问题标成 Nit:真正需要修的问题被作者忽略,风险直接进主干。

易错点

  • 把实质问题标成 Nit:作者按非阻塞处理,缺陷被带上线。
  • 反向把 nit 当阻塞理由来回拉扯:浪费评审轮次,交付节奏被拖慢。
  • 团队各用各的前缀:作者要额外判断谁的意见算数。
  • 全部评论都加 Nit 前缀:等于没有区分,主次重新变得模糊。

数据来源与参考

  • Google Engineering Practices · How to write code review comments(Nit 惯例)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌