如何利用代码审查提升你的代码质量?

代码审查会减缓自己代码的进度,但也是一个提升自己代码,并向其他聪明、经验丰富的工程师学习的机会。那么怎么才能充分利用这个机会呢?
 
尽量让你的代码变动出现在第一轮审查中,只有轻微的评论。如果你的代码审查通常需要多轮的意见,这些技巧可以节省你的时间。
 
有效的利用你的代码审查者的时间,这是一种有限的资源。如果他们发现了那种你自己很容易就能发现的问题,这会降低你的团队的整体工作效率。
 在你的代码进行审查之前:
 
重新评估你的代码:不要像以前测试时一样随便把评审代码送去审查。至少要重新从整体上思考一遍。尤其是如果当天时间已经晚了,看看第二天早上是否会有更好的想法。虽然这样可能会拖慢个人代码的变化,这将从长期上带来更大的平均吞吐量。
 
考虑做一次非正式的设计探讨:如果你有不确定的事,和审查者面对面交流,或提前提出异议并要求一次整体设计上的“预审”。
 
自行审查更改:试着从一个什么都不知道的人的角度,尽可能严格的看自己的代码。你的代码审查工具会比IDE更能给你根本上的不同看法。这将很容易的为你免去一次往返。
 
使差异容易理解:一下子出现的多种改变让代码更难审查。当你自行审查,寻找能减少差异的简单更改。例如,保证重要的重构或格式变化。
不要隐藏提交消息中的重要信息:把它也放在代码中。之后阅读代码的人是不可能看提交的消息的。
 当你处理代码审查意见:
 
处理完重要意见后,重新评估你的代码:退一步并用真正全新的眼光去看代码。一旦完成了一组更改,你会发现,这些更改经常会带来额外的改进。正如任何的重构,它可能需要几个步骤来达到最佳设计。
 
弄明白审查者做出的每一个注释:如果你不明白注释背后的原因,不要仅是修改代码——去找审查者弄清楚,以便自己能学习新的东西。
 
回复审查者在代码上的问题:不只是回复——让代码更容易理解(例如,提高一个变量名、更改一个布尔值等等)——或添加注释。以免之后其他人也会有同样的问题。
 
作者:潇潇和她的第二人格
链接:http://www.jianshu.com/p/d6d2256a5362
來源:简书

0 个评论

要回复文章请先登录注册