【经验交流】组队检查代码只需要5步

精华 发表在    琉星大陆 08-08 10:16:16

3 2141 2

(网上转载滴)


当你写好一段代码的时候,你会迫不及待地保存,还是先检查一番呢?想一想,如果是考试时,你在离交卷还有一段时间时做完了题目,你是选择立刻交卷还是最后检查一遍呢?“再检查一遍”无疑是提高卷面正确率的更好选择,代码审查也是同样的道理——写好了,再检查一遍!

 

不过,和我们考试时不一样的是,程序员的审查并不是孤军奋战,我们通常组队活动。试想一下,如果考试交卷前还可以请班里的学霸帮你检查试卷,是不是胜算又多了几分呢?即使对方不是“学霸”,换一个人,换一种角度看问题,很有可能得出不一样的、对你有所启发的答案。在学习编程的路上,没有人是一座孤岛,互相交流学习是非常有益及有必要的.

 

接下来,我们就告诉大家程序员组队互相检查的5个步骤吧!这些步骤是拥有320万行代码经验的编程高手们总结出来的,希望能对你有所帮助。

 

一、确定合作基调

首先,你需要让团队的成员(包括你自己)明白,互相检查代码没有什么坏处。指出错误的目的不是为了证明“谁是更厉害的程序员”、“谁写的代码不够好”,而是为了帮助团队的每一个人写出更好的代码。总之,要在团队里营造友好合作的氛围。

 

二、给自己的代码加上注释!

给自己的源码加上注释吧,注释可以帮助你的同伴更好地理解你的意思,也能让你在几天、几个月甚至几年后回顾自己的代码是能很快找回思路。以下给大家提供几种语言的注释示例:

 

Java

1 //单行注释

2 /*多行注释*/

 

C

/*注释*/

 

C++

//单行注释

/*多行注释*/

 

C#

//注释

/*注释*/

///注释

(注:第三种是xml注释,需要编译器支持)

 

HTML

<!--注释-->

 

CSS

/*多行注释*/

 

(大家还有别的例子欢迎补充!)

 

三、做好时间规划

加注释固然很重要,不过,如果你不想一整天都花在检查代码上,那就要做好时间规划啦。如何规划才是最合理的呢?思科公司(Cisco)的调查数据显示,程序员一次检查少于200-400行代码时工作效率最高。

 


我们来看这张图表,横轴是总共检查的代码行数,竖轴是每一千行代码中检查出来的小错误数量。我们可以看到,当检查数量达到400及以上时,检查出来的问题数量就急剧下降了。这并不意味着400行以后的代码质量更高,而是——检查者累啦!

 

一次检查时的代码数量应当少于200-400,那么,一次检查的时间应该是多长呢?我们认为,60分钟是一个合适的数字。超过60分钟做同一件事,你可能会感到疲劳,效率也没有刚开始那么高了。

 

四、制定清晰的目标

看到这里,你可能会想,目标不就是“帮助每个人写出更好的代码”吗?没错,但“更好的代码”只是一个模糊的概念:怎样的代码是更好的?衡量标准是什么?为了达成这个目标需要做什么?……模糊不清的目标会引发一系列问题。

 

因此,我们建议大家设定一个具体的的目标,这个目标中包含一个具体的数字,每个团队成员都可以理解,并且知道为了达成目标具体要做些什么,呈现的效果如何。假如你们是“QQ PC版”这个应用的程序员,你们可以设置一个“减少10%技术支持问题 ”的目标

 


(解决掉1/10的反馈问题)

 

五、确保代码真的被修改了!

如果大家辛辛苦苦提出了修改建议,但是代码原作者却忘了改,这真的很可惜——不要怀疑,这样的懒虫真的存在(比如作者本人)。你的代码互检小组要想办法跟进组员,直到最后一步,代码真的被修改了,才算大功告成噢!



登录或注册后发布评论
author avatar

电竞男神

英勇黄铜Ⅴ 84荣誉值

1

0

4

电竞男神的其他帖子