2020软件工程结对作业

一、相关作业要求

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

二、审查代码的详细审查表

审查人	李建红	审查日期	2020.4.13

序号	重要性	审查项	结论
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	重要	将布尔变量直接与TRUE、FALSE或者1、0进行比较。
26	重要	将浮点变量用“==”或“！=”与任何数字比较。
27	重要	将指针变量用“==”或“！=”与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	重要	变量的数据类型有错误吗？	否
57	重要	存在不同数据类型的赋值吗？
58	重要	存在不同数据类型的比较吗？
59	重要	变量的初始化或缺省值有错误吗？	否
60	重要	变量发生上溢或下溢吗？
61	重要	变量的精度够吗？
62	重要	由于精度原因导致比较无效吗？
63	重要	表达式中的优先级有误吗？
64	重要	逻辑判断结果颠倒吗？	否
65	重要	循环终止条件不正确吗？	否
66	重要	无法正常终止（死循环）吗？	否
67	重要	错误地修改循环变量吗？
68	不重要	存在误差累积吗？
69	重要	忘记进行错误处理吗？	是
70	重要	错误处理程序块一直没有机会被运行？	否
71	重要	错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。
72	不重要	错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	否
73	不重要	对不存在的或者错误的文件进行操作吗？
74	不重要	文件以不正确的方式打开吗？
75	重要	文件结束判断不正确吗？
76	不重要	没有正确地关闭文件吗?

三、代码优缺点的总结

优点：1.变量包括函数的命名都很直观，有特殊的含义，便于后期的阅读；例如参数lchild,rchild的命名，代表含义：左孩子，右孩子；函数GreateBiTree(), Enqueue()，代表含义:创建二叉树，插入结点操作。
2.结构化清晰，整体布局很好。对于程序中需要的用到的函数全部进行了单独的编写，在主函数里面只是进行简单的调用，和一些简单的操作。
3.没有多余的变量存在以及2句或2句以上的语句处于同一行，读起来很清晰。
缺点：没有一些简单的注释，导致在某一点读起来还是不是很理解，希望以后可以改正。

四、相关的审查代码链接

https://github.com/lyt1234567/soft/blob/master/树.cpp