首页/开发/代码质量与评审速查/Conventional Comments:给评论打标签
代码评审64 条

Conventional Comments:给评论打标签

Conventional Comments 约定用标签起始评论:praise、nitpick、suggestion、issue、todo、question、thought,让作者识别类型与紧急度。

常用标签与含义

标签含义典型处理
praise肯定做法无需行动
nitpick小问题(不阻塞)可改可不改
suggestion建议性改进作者判断
issue明确问题应处理
todo小任务计划内处理
question疑问或澄清需要回答
thought引出讨论的想法视讨论结果

格式示例

格式示例
suggestion (non-blocking): 这里可以复用已有的重试装饰器,减少重复逻辑。
issue: 并发场景下这个读取没有加锁,可能读到半更新状态。
标签可配修饰词:blocking / non-blocking 标出阻塞性,减少来回确认。

易错点

  • 全用 issue 标签:小问题也标成问题,作者无法排序
  • 标签与内容不符(标 nitpick 却提阻塞性问题):误导优先级

数据来源与参考

  • Conventional Comments 规范(conventionalcomments.org)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌