程序员工具箱

高效进行代码回顾(Code Review)

2019-12-26  本文已影响0人  qinyu
WTF/m

代码回顾是帮助团队养成编写高质量代码的习惯的手段之一。


1. 代码回顾应该...

❓实现的逻辑错误如何来发现


2. 代码质量

“代码”包括了代码仓库中的所有文件(资源、配置、脚本、文档...)

2.1 可读的代码

一致的代码样式--保持一致避免代码合并频繁冲突,提升阅读代码的舒适度:

代码风格本身不影响代码含义,但影响阅读的舒适度,不一致的风格容易产生合并冲突

💡Tips

有意义的命名--准确地表达代码的意图,包括业务上的意图(功能)和设计上的意图(架构、模式)

💡Tips

2.2 优雅的代码

代码坏味道--发现代码之中潜在问题的信号

常见代码坏味道

Android Lint Checks:https://sites.google.com/a/android.com/tools/tips/lint-checks

💡Tips

2.3 模块化的代码

(反)模式--识别可以复用的代码“套路”,不符合整体架构的代码。

💡Tips


3. 回顾的形式

XP反馈环

3.1 编写时回顾

在第一时间发现代码中的各种问题,并进行修正。

💡Tips

3.2 提交前交叉回顾

确保原子提交,提交的代码不是“半成品”。

💡Tips

3.3 集成前交叉回顾

PR 强制交叉回顾,确保集成到主干上的代码符合代码规范。跨地域、跨团队协作,无法及时面对面进行交叉回顾时采用。

💡Tips

3.4 集成后集体回顾

定期(每周至少3次)对重点代码进行集体回顾,分享业务知识、技术知识和设计知识。

💡Tips


5. 小结

无时无刻、无处不在

响应变化、持续优化

build-quality-in-legacy-system.jpg

6. 参考:

上一篇 下一篇

猜你喜欢

热点阅读