软工2017第四周作业——代码规范

最新推荐文章于 2024-08-29 12:39:59 发布

weixin_30951231

最新推荐文章于 2024-08-29 12:39:59 发布

阅读量97

点赞数

文章标签：开发工具 java

原文链接：http://www.cnblogs.com/liusx0303/p/7625814.html

版权

这篇博客主要写以下两点：

1、结对编程的十条规范

2、规范的执行情况

我的小伙伴是胡佑蓉，她的博客地址是：http://www.cnblogs.com/huyourongmonkey/

一、Java结对编程之前的十条代码规范

1、大括号匹配纵列对齐，括号占一行，括号后换行写语句，例如：

if (hours < 24 && minutes < 60 && seconds < 60)

{
    return true;
}
else
{
    return false;
}

2、方法名与功能相关，便于看代码的人理解方法大致功能，且方法名小写，例如写一个数字相加的方法，取名为addNumber。

3、关键代码写好注释，更新代码记得把相应的代码注释也更新。

4、关于空格空行问题：方法与方法之间空两行；函数内部变量声明与函数内部逻辑空一行，两个内部逻辑之间空一行。

5、每个方法代码不超过40行。

6、变量名取名符合标识符含义，不可以随意取。

7、代码中接口的名字以大写的“I”开头（不是1），便于查看代码时知道那个是接口。

8、命名大小写的问题：

类名：首字母大写，其他单词中首字母大写，其他小写
方法名：首字母小写，其他单词中首字母大写，其他小写
变量：与方法名规则同
包名：全部小写

9、用空格字符缩进源代码，不用tab键。

10、表明类，域和方法等的意义和用法的注释，要以javadoc的方法来写。

11、无效的代码要删除，不要保留。

12、无效的注释不要写注释。

二、规范的执行情况

如表：（注：H代指胡佑蓉，L代指刘淑霞）

规范	情况记录	更改
第一条	由于eclipse自动生成的大括号就在语句后面，两人犯错n次，后来经过相互提醒，犯错次数减少，最后可不计	规则有效，无更改
第二条	L触犯2次，纠正2次，H无犯错	规则有效，无更改
第三条	H触犯1次，纠正1次，更新代码时未更新注释，L无犯错	规则有效，无更改
第四条	H触犯6次，纠正6次，L触犯5次，纠正5次，两人总是不习惯空行，后渐渐少触犯规则，但两人还是有触犯	规则有效，无更改
第五条	完成功能过程中，实现某个方法代码过长，超过40行两个，各犯错一次，各纠正一次	弱化规则，更改为每个方法代码不超过60行
第六条	H触犯1次，L触犯3次，有报错，无人提醒立即更改	规则有效，无更改
第七条	没有使用	规则作废，更改为无效的代码要删除，不要保留，改为规则11
第八条	H触犯6次，纠正6次，L触犯2次，纠正6次	规则有效，无更改
第九条	H触犯1次，纠正1次，L触犯1次，纠正1次	规则有效，无更改
第十条	没有使用	规则作废，更改为无效的注释不要写注释，更改为规则12
第十一条	H无犯错，L触犯3次，纠正3次	规则有效
第十二条	H犯错8次，纠正8次,L无触犯	规则有效

转载于:https://www.cnblogs.com/liusx0303/p/7625814.html

关注