你有一份代码审查问题清单,请查收
文 | EarlGrey
推荐 | 编程派公众号(ID:codingpy)
在团队协作编码时,代码审查是一个非常重要的环节,可以一定程度上保障代码的质量。当然,如果代码审查工作执行不到位,或者没有抓住重点,这对于整个团队的成长是无益的。
今天要分享给大家的,是一位英国工程师 David Seddon 整理的代码审查问题清单,指出了可能很多人在做代码审查时可能会忽略的问题。这位工程师的背景非常有意思,是英语语言文学专业毕业,还从事过一段时间的表演工作。
代码审查过于关注细节
David 结合自己的经验,认为大多数人在做代码审查时,过于关注细节,忽略了对需求和全局的思考,更多地去关注代码的正确性,甚至是代码的风格。
这是他认为不可取的地方。
在他看来,代码审查除了可以确保质量之外,还是内部系统性地共享知识的有效方式。做代码审查时,更重要地是思考代码的作者可能由于赶进度而遗漏的问题。
为了更好地朝正确的方向执行,他给出了一份问题清单,刚好对应特性发布前所要经历的 4 个阶段。
问题清单
1、需求定义
我们为什么这样做?
范围是否明确?
系统在不同的场景中应该如何表现?
是否遗漏了任何边缘案例?
2、代码实现
你是否完全明白开发的功能是什么?
最终用户的体验有多好?
代码质量高吗?
测试覆盖率怎么样?
对本地开发有什么影响吗?
后面怎么提升性能?
3、功能验证
你有信心它确实有效吗?
是否有质量保证计划?
有任何未经测试的场景吗?
我们应该对系统的哪些部分进行回归测试?
4、特性发布
是否有明确的发布计划?
是否存在数据丢失的风险?
特性发布对系统当前的响应会有什么影响?
以上就是本文的全部内容,希望分享的这个问题清单和代码审查的思路,能够对大家有所帮助。
作者原文:https://seddonym.me/2018/03/27/code-review-checklist/
回复下方「关键词」,获取优质资源
回复关键词「 pybook03」,立即获取主页君与小伙伴一起翻译的《Think Python 2e》电子版
回复关键词「书单02」,立即获取主页君整理的 10 本 Python 入门书的电子版
豆瓣 9.1 分,中文版销量 30 多万,零基础也能用这本书学会 Python
题图:pexels,CC0 授权。