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

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

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

惯例Nit: — 小问题、非阻塞
适用措辞、格式、微小的可读性改进
  • Nit 表示不阻塞:作者可以接受,也可以用理由说明后忽略
  • 不带前缀的评论通常被理解为需要处理
  • 团队也可约定其他前缀(如 Optional、FYI),但需在团队内统一
前缀是为了省沟通成本:让作者一眼分清主次,而不是降低标准。

易错点

  • 把实质问题标成 Nit:真正需要修的问题被作者忽略
  • 反向把 nit 当阻塞理由来回拉扯,浪费评审轮次

数据来源与参考

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