结对编程作业

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

1.作业介绍

1，结对项目：推箱子小游戏

2，结对伙伴：王晶

3，结对伙伴代码地址：伙伴代码地址

4，自己代码地址：自己代码地址

2.代码审查表

序号	重要性	审查项	结论
1	重要	头文件和定义文件的名称是否合理？	是
2	重要	头文件和定义文件的目录结构是否合理？	是
3	重要	版权和版本声明是否完整？	无
4	重要	头文件是否使用了 ifndef/define/endif 预处理块?	是
5	重要	头文件中是否只存放“声明”而不存放“定义”	是
6	重要	空行是否得体？	是
7	重要	代码行内的空格是否得体？	是
8	重要	长行拆分是否得体？	否
9	重要	“{” 和 “}” 是否各占一行并且对齐于同一列？	否
10	重要	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	是
11	重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	是
12	重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	是
13	重要	注释是否有错误或者可能导致误解？	否
14	重要	类结构的public, protected, private顺序是否在所有的程序中保持一致？	否
15	重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
16	重要	标识符是否直观且可以拼读？	是
17	重要	标识符的长度应当符合“min-length && max-information”原则？	否
18	重要	程序中是否出现相同的局部变量和全部变量？	否
19	重要	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是
20	重要	静态变量、全局变量、类的成员变量是否加前缀？	无
21	重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	无
22	重要	是否编写太复杂或者多用途的复合表达式？	无
23	重要	是否将复合表达式与“真正的数学表达式”混淆？	无
24	重要	是否用隐含错误的方式写if语句? 例如
25	重要	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	无
26	重要	（2）将浮点变量用“==”或“！=”与任何数字比较。	无
27	重要	（3）将指针变量用“==”或“！=”与NULL比较。	无
28	重要	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判	是
29	重要	断移到循环体的外面？	是
30	重要	Case语句的结尾是否忘了加break？	否
31	重要	是否忘记写switch的default分支？	否
32	重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	否
33	重要	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	否
34	重要	在C++ 程序中，是否用const常量取代宏常量？	无
35	重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	无
36	重要	是否误解了类中的const数据成员？因为const数据成员只在某个对象	无
37	重要	生存期内是常量，而对于整个类而言却是可变的。	否
38	重要	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
39	重要	参数命名、顺序是否合理？	是
40	重要	参数的个数是否太多？	是
41	重要	是否使用类型和数目不确定的参数？	否
42	重要	是否省略了函数返回值的类型？	否
43	重要	函数名字与返回值类型在语义上是否冲突？	否
44	重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否
45	重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	否
46	重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	否
47	重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？	否
48	重要	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	否
49	重要	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）	否
50	重要	是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	否
51	重要	数组或指针的下标是否越界？	否
52	重要	动态内存的申请与释放是否配对？（防止内存泄漏）	否
53	重要	是否有效地处理了“内存耗尽”问题？	否
54	重要	是否修改“指向常量的指针”的内容？	否
55	重要	是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。	否
56	重要	是否将malloc/free 和 new/delete 混淆使用？	否
57	重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	否
58	重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	无

 

3.评价

本次的作业是和结伴队友一起开发的推箱子的小游戏，审查了伙伴的队友代码之后，我发现如下的一些问题：

(1) 伙伴的代码在写注释的时候，有写代码的注释写在了不明显的位置，这样当别人在读你的代码的时候，可能会出现不明白的地方，但是又在第一时间看不到详细的注释，会造成比较大困难，建议以后在写代码的时候将代码的注释放在醒目的位置，或者直接要解释的代码的后面写注释，这样可以让人很方便的找到。

(2)在对一个函数进行注释的时候，有时候一行的注释不够写，可以在接下来没有代码的一行继续写，不要在有代码的行的后面写，这样会造成误解，让代码的可读性变差。

(3)在定义函数的时候，建议函数的名字不要用拼音代替，尽量多的使用英语单词去表述，这样更有意义，另外行数的名称的首字母一般选择大写，这样比较美观。

(4)在设置函数返回值时候，要思考一下这个返回值的作用，对于没有作用的返回值，我们可以定义函数的返回值为viod的类型，这样就不会有多余的函数返回值需要考虑。

(5)对于程序中只用的算法，可以加以说明，指出算法的原理，或者指出算法的名称，这样方便人们理解。

但是审查了伙伴的代码之后，我也发现了伙伴代码的一些优点：

(1)伙伴使用define来定义变量 ，这样在后面的代码修改中很方便，避免了很多机械的操作。

(2)使用了一个全局的二维数组，从而避免了各个函数在使用数组的时候需要不断的传递参数，不光提高了效率，也减少了错误，很实用。

(3)代码分模块编写，结构清晰明了，便于后期的代码修改和维护。

4，总结

这次的开发对C语言有了进一步的认识和使用，关于ASCLL的查询，部分头文件和库函数的学习比较，我总结在了另一篇的博客里面，请点击这里查看！谢谢！！！