软件工程第三次作业：代码复审

作业要求

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

---

复审代码

复审代码题目

【问题描述】给定一棵二叉树和二叉树中的任意两个节点的值，求这两个节点的最近共同祖先。按先序遍历序列建立链式存储结构的二叉树。
【输入形式】按照先序输入二叉树中结点的值，字符*表示空树，每个字符之间用空格隔开。下一行中输入节点值，空格分隔。
【输出形式】祖先节点值。
【样例输入】a b c d * * * * *
c d
【样例输出】b

复审代码地址

代码

序号	重要性	审查项	结论
0	重要/不重要	审查表中待检查内容	填写是/否/无
1	不重要	头文件和定义文件的名称是否合理？	是
2	不重要	头文件和定义文件的目录结构是否合理？	是
3	不重要	头文件中是否只存放“声明”而不存放“定义”	无
4	不重要	版权和版本声明是否完整？	无
5	重要	头文件是否使用了 ifndef/define/endif 预处理块?	无
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	不重要	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？	无
26	重要	Case语句的结尾是否忘了加break？	无
27	重要	是否忘记写switch的default分支？	无
28	重要	使用goto 语句时是否没有留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	是
29	不重要	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是
30	不重要	在C++ 程序中，是否用const常量取代宏常量？	无
31	重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	是
32	不重要	是否误解了类中的const数据成员？因为const数据成员只在某个对象	无
33	不重要	生存期内是常量，而对于整个类而言却是可变的。	是
34	不重要	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
35	不重要	参数命名、顺序是否合理？	是
36	不重要	参数的个数	是
37	不重要	是否没有使用类型和数目不确定的参数？	是
38	不重要	是否没有省略了函数返回值的类型？	是
39	不重要	函数名字与返回值类型在语义上是否不冲突？	是
40	重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否
41	重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	否
42	重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	无
43	重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？	无
44	不重要	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	无
45	不重要	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）	是
46	重要	是否没有忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	是
47	重要	是否没有数组或指针的下标越界？	是
48	重要	动态内存的申请与释放是否配对？（防止内存泄漏）	无
49	重要	是否有效地处理了“内存耗尽”问题？	否
50	重要	是否修改“指向常量的指针”的内容？	无
51	重要	是否没有出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。	是
52	重要	是否将malloc/free 和 new/delete 混淆使用？	无
53	重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	无
54	重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	否
55		C++的高级特性及类的高级特性	无
55	重要	数据类型问题：	是
56	重要	变量值问题：	是
57	重要	逻辑判断问题：	是
58	重要	循环问题：	是
59	重要	错误处理问题：	无
60	重要	文件I/O问题：	无

---

复审评论

  这次复审的代码使用的语言为c语言，该代码的主要功能是对给定的任意两个结点找他们共同的父节点，代码中使用到队列，树等数据结构，通过构建完全二叉树实现寻找每个结点的父节点，进而找到共同的父节点。代码整体思路清晰，使用许多函数表示相应功能，减少代码冗余，增强可读性，便于修改，而且大部分的函数命名可以直接看出函数的功能。队列和树的定义和初始化也很标准，指针数组均没有越界情况，对变量的处理也准确无误，不存在不同类型的赋值比较等情况。代码对问题中可能出现的不同情况均处理得当。
  针对审查中的重要问题代码基本都处理得当，但是也存在一些问题，首先是代码没有注释，建议在代码中添加注释，尤其是对定义的函数及其参数和代码的主要功能，没有注释导致代码阅读和理解较为困难。代码在对树和对列的定义时变量名比较准确，可以直接看出其表示的含义，但在主函数和化成完全二叉树的函数中则使用了a1,a2,c1,c2,r1,r2这种命名方式，使代码可读性变差，建议使用可以直接表示变量含义的变量或者添加注释。代码中存在未使用的多余变量，浪费空间。还有格式上，有一行几句代码，并且“{”没有独占一行，整个大括号中的代码不能进行逐句调式。在使用new申请完空间后没有释放，并且少一些出错处理，以上对复审代码优缺点的评论及给出的建议。

---