Code Review
2023-05-16 19:32:22 0 举报AI智能生成
代码审查是除了作者之外的其他人进行代码检查的过程，通过代码审查可以保证我们代码和产品的质量
作者其他创作
大纲/内容
明确目的：确保公司代码质量随着时间的推移得到逐步提升
CL 作者指南
要求
Commit 小型变更清单
为什么提交小型变更清单？
审查更快、更彻底
不容易引人 bugs
如果被拒绝，浪费的工作很少
很容易被合并、也容易进行回滚操作
很容易做出好的设计
一个正确大小的CL
CL只进行了一个最小的变更，这个变更只解决一件事。
CL应该包含对应的单元测试，保证测试代码在同一 CL 中
CL不应过小而导致难以理解。
CL 描述明晰准确
不影响系统工作：合并这个CL之后，系统一切工作正常
什么时候大的CL 是可以的？
语义化 Commit 消息规范
如何处理代码审查者的评论？
不要针对个人
不要愤怒地回应审查评论
解释代码
代码评审者的指南
准则：技术事实和数据要优先于观点与个人风格
编程风格
谷歌风格指南
软件设计
要求
主要关注点
设计&复杂度
功能&测试
命名&注释
编程风格
说明文档
鼓励好的方面
查看 CL 的步骤
把握变更的全貌
检验 CL 的关键部分
以合适顺序查阅 CL 其余内容
审查速度的如何要求？
代码审查的速度要快
最长一个工作日(即第二天早上的第一件事)
如何处理开发者代码审查中的拖延？
谁是对的，达成一致
拒绝稍后处理
一些建议
如何书写代码审查评论
礼貌
解释为什么
给予指导
接受解释
参考文献
谷歌开源的代码评审规范
Go Code Review Comments
effective_go
0 条评论
下一页
