软件工程第三次作业

软件工程第三次作业

博客信息	沈阳航空航天大学计算机学院2020软件工程作业
作业要求	https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616
课程目标	熟悉一个“高质量”软件的开发过程
作业目标	熟悉代码规范及结对互审

 

一、代码地址

 通讯录同步功能

二.项目审查表

序号	重要性	审查项	结论
1	不重要	命名规则是否与所采用的规范保持一致？	是
2	不重要	是否遵循了最小长度最多信息原则？	是
3	重要	has/can/is前缀的函数是否返回布尔型？	是
4	不重要	注释是否较清晰且必要？	是
5	不重要	复杂的分支流程是否已经被注释？	是
6	不重要	距离较远的}是否已经被注释？	是
7	不重要	非通用变量是否全部被注释？	是
8	重要	函数是否已经有文档注释？（功能、输入、返回及其他可选）	无
9	不重要	特殊用法是否被注释？	无
10	不重要	每行是否只声明了一个变量？（特别是那些可能出错的类型）	是
11	重要	变量是否已经在定义的同时初始化？	是
12	重要	类属性是否都执行了初始化？	是
13	不重要	代码段落是否被合适地以空行分隔？	是
14	不重要	是否合理地使用了空格使程序更清晰？	是
15	不重要	代码行长度是否在要求之内？	是
16	不重要	折行是否恰当？	是
17	不重要	包含复合语句的{}是否成对出现并符合规范？	是
18	不重要	是否给单个的循环、条件语句也加了{}？	是
19	不重要	if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？	是
20	不重要	单个变量是否只做单个用途？	是
21	重要	单行是否只有单个功能？（不要使用；进行多行合并）	是
22	重要	单个函数是否执行了单个功能并与其命名相符？	是
23	不重要	操作符＋＋和— —操作符的应用是否复合规范？	是
24	重要	单个函数不超过规定行数？	无
25	重要	缩进层数是否不超过规定？	是
26	重要	是否已经消除了所有警告？	是
27	重要	常数变量是否声明为final？	是
28	重要	对象使用前是否进行了检查？	是
29	重要	局部对象变量使用后是否被复位为NULL？	否
30	重要	对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。	是
31	重要	是否确认没有同名变量局部重复定义问题?	是
32	不重要	程序中是否只使用了简单的表达式？	是
33	重要	是否已经用（）使操作符优先级明确化？	否
34	重要	所有判断是否都使用了（常量==变量）的形式？	无
35	不重要	是否消除了流程悬挂？	无
36	重要	是否每个if-else if-else语句都有最后一个else以确保处理了全集？	是
37	重要	是否每个switch-case语句都有最后一个default以确保处理了全集？	否
38	不重要	for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX）	是
39	重要	XML标记书写是否完整，字符串的拼写是否正确?	无
40	不重要	对于流操作代码的异常捕获是否有finally操作以关闭流对象?	无
41	不重要	退出代码段时是否对临时对象做了释放处理?	否
42	重要	对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断）	无
43	重要	入口对象是否都被进行了判断不为空？	是
44	重要	入口数据的合法范围是否都被进行了判断？(尤其是数组)	无
45	重要	是否对有异常抛出的方法都执行了try...catch保护？	无
46	重要	是否函数的所有分支都有返回值？	是
47	重要	int的返回值是否合理？（负值为失败，非负值成功）	是
48	不重要	对于反复进行了int返回值判断是否定义了函数来处理？	是
49	不重要	关键代码是否做了捕获异常处理?	无
50	重要	是否确保函数返回CORBA对象的任何一个属性都不能为null?	无
51	重要	是否对方法返回值对象做了null检查，该返回值定义时是否被初始化?	是
52	重要	是否对同步对象的遍历访问做了代码同步?	否
53	重要	是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作?	无
54	重要	线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出?	无
55	不重要	原子操作代码异常中断，使用的相关外部变量是否恢复先前状态?	否
56	重要	函数对错误的处理是恰当的?	是
57	重要	实现代码中是否消除了直接常量？（用于计数起点的简单常数例外）?	是
58	不重要	是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )?	否
59	不重要	是否每个return前都要有日志记录?	否
60	不重要	是否有冗余判断语句？（如：if (b) return true; else return false;?	否
61	不重要	是否把方法中的重复代码抽象成私有函数?	是

三、总结   

　　在本次双人结对过程中，由于我是第一次结对做作业，刚开始我还找不到队友，但是，最后在群里的招集下，我找到了队友，我们先讨论了我们互相的代码，找到了和时代的代码开始研究，找到了以往做的的课设题目去讨论。我伙伴的代码简单易懂，非常好。功能也简洁。
   这次我同伴做的是通讯录同步功能，通讯录同步功能的要求是计一个通讯录系统，能够提供通讯录的增加、删除、修改以及查找等功能，同时假设通讯录是随着时间不短变化的，而每过一段时间需要对通讯录进行备份，即同步当前最新的通讯录到副本中，同时要给出发生的变化。同伴的代码中可以使用链表和使用数组，使用链表可以按照要求开辟空间，但是如果使用数组有可能会浪费内存空间。同伴的代码同时对文件的操作很熟练，没有出现什么太大的问题。同伴的代码有些小缺陷，就是注释太少了，有些重要的功能给的注释完全不够，还有一些缺点就是代码量太大，可以精简一些。不过同伴的代码功能很全，对通讯录的所有功能都一一做到了，让我很佩服。
  本次结对作业通过审查他人代码让我发现了自己身上的不足和编程时的问题所在，编写代码时对注释的运用不够灵活和勤快，懒于注释代码，这对想要读懂我写的代码的人来说造成了很大的不便，需要改正。总体来说是一份优秀的代码，使我收获颇多，也意识到了自己的不足之处。