首页/开发/代码质量与评审速查/评审评论怎么写:问题 + 原因 + 建议
代码评审64 条

评审评论怎么写:问题 + 原因 + 建议

Google 评论写作指南:评论要说明问题的原因与影响,并给出方向性建议或提问,而不是只丢一句结论。

结构问题 + 原因或影响 + 建议(或提问)

评论对比示例

评论对比示例
差:这里不要这么写。
好:这里两次查询之间没有事务,并发下可能读到不一致状态;
     能否合并为一次查询,或用事务把两次读包住?
带上为什么的评论能被后来人理解,也避免作者反复追问背景。

易错点

  • 只给结论不给原因:作者只能猜评审者意图,来回轮次变多
  • 一条评论塞多个问题:作者容易漏改,讨论线索也会混在一起

数据来源与参考

  • Google Engineering Practices · How to write code review comments
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌