首页/开发/代码质量与评审速查/CL 作者指南:写清意图再请评审
代码评审64 条

CL 作者指南:写清意图再请评审

Google 作者指南要点:把改动写成单一自包含的 CL、在描述里写清意图与验证方式、提交前先自审,然后邀请评审并快速响应意见。

文档The CL Author's Guide
关键动作描述意图 / 控制大小 / 先自审 / 响应意见
  • CL 应是一个自包含的完整改动,能独立理解与回滚
  • 描述里写清:改什么、为什么改、怎么验证(命令与结果)
  • 提交评审前先通读一遍完整 diff,去掉调试残留
  • 收到评论后逐条响应:修改、解释原因或提出替代方案
作者对评审效率负一半责任:描述越清楚,来回轮次越少。

易错点

  • 只写'修复问题'式描述,评审者被迫从 diff 反推上下文
  • 把重构与功能改动混在一个 CL:行为变化与结构调整交织,评审难度成倍上升

数据来源与参考

  • Google Engineering Practices · The CL Author's Guide
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌