这篇博客主要由三大部分进行说明:
1. 结对要求
2.《代码风格规范》
3.《代码风格规范》执行情况记录
一,结对要求
1.每2人自愿结成1对,代码规范、单元测试、四则运算试题生成,均由此2人共同完成。
2.要求此2人单元测试和四则运算试题生成编码,在真实物理空间中相距不得超过的距离,可以不借助设备对话。一般地,相距一两米内,2人共同使用同一台显示器、同一套鼠标键盘,可以符合要求。
3.此前累积成绩前10%的同学,禁止彼此结对。
在老师提出“结对编程”这个词的时候,我和小霞就心照不宣自愿组成一对了。原因有多种,第一,我们关系好,第二,我们各自擅长的东西,在一起可以相互学习,共同进步,第三,我们在一个宿舍和一个实验室,方便交流,且除了一起结对编程的时间外,还可以一起面对面交流如何一起完成作业。
合作伙伴刘淑霞的博客地址如下:http://www.cnblogs.com/liusx0303/
二,《代码规范》
在两个人的讨论下,达到共识后,定下了这十条规范:
1、大括号匹配纵列对齐,括号占一行,括号后换行写语句。
2、方法名与功能相关,便于看代码的人理解方法大致功能,且方法名小写,例如写一个数字相加的方法,取名为addNumber。
3、关键代码写好注释,更新代码记得把相应的代码注释也更新。
4、关于空格空行问题:方法与方法之间空两行;函数内部变量声明与函数内部逻辑空一行,两个内部逻辑之间空一行。
5、每个方法代码不超过40行。
6、变量名取名符合标识符含义,不可以随意取。
7、代码中接口的名字以大写的“I”开头(不是1),便于查看代码时知道那个是接口。
8、命名大小写的问题:
类名:首字母大写,其他单词中首字母大写,其他小写
方法名:首字母小写,其他单词中首字母大写,其他小写
变量:与方法名规则同
包名:全部小写
9、用空格字符缩进源代码,不用tab键。
10、表明类,域和方法等的意义和用法的注释,要以javadoc的方法来写。
三,《代码风格规范》执行情况记录
如表:(注:H代指胡佑蓉,L代指刘淑霞)
规范 | 情况记录 | 更改 |
规则1 | 由于eclipse自动生成的大括号就在语句后面,两人犯错28次,纠正28次,后来经过相互提醒,犯错次数减少,最后可不计。 | 规则有效,无更改 |
规则2 | L触犯2次,H无犯错,L经提醒纠正2次 | 规则有效,无更改 |
规则3 | H触犯1次,更新代码时未更新注释,L无犯错,H纠正1次 | 规则有效,无更改 |
规则4 | H触犯6次,L触犯5次,两人总是不习惯空行,后渐渐少触犯规则,但两人还是有触犯。H纠正5次,L为H纠正1次。L纠正5次。 | 规则有效,无更改 |
规则5 | 完成功能过程中,实现某个方法代码过长,超过40行。H触犯1次,纠正1次 | 弱化规则,更改为每个方法代码不超过60行 |
规则6 | H触犯1次,L触犯3次,有报错,无人提醒立即更改,纠正犯错对应次数 | 规则有效,无更改 |
规则7 | 没有使用 | 规则作废,更改为无效的代码要删除,不要保留,改为规则11 |
规则8 | H触犯6次,L触犯2次。H纠正6次,L纠正2次 | 规则有效,无更改 |
规则9 | H触犯1次,L触犯1次。H纠正1次,L纠正1次。 | 规则有效,无更改 |
规则10 | 没有使用 | 规则作废,更改为无效的注释不要写注释,更改为规则12 |
规则11 | H无犯错,L触犯3次。L纠正3次 | 规则有效 |
规则12 | H犯错8次,L无触犯。H纠正8次 | 规则有效 |