软件工程（2019）结对编程第一次作业

最新推荐文章于 2024-09-14 18:34:13 发布

asdpps2335535

最新推荐文章于 2024-09-14 18:34:13 发布

阅读量117

点赞数

文章标签： c/c++ java 数据结构与算法

原文链接：http://www.cnblogs.com/Carlos-Yao/p/10756683.html

版权

1.代码地址

该项目是孙治朝同学的数据结构课程设计项目，项目的Coding地址为：静水流深i
孙治朝同学的博客地址为：静水流深i

2.C/C++代码审查表

代码审查表的设计参考了CSDN的这篇博文C/C++代码审查表和这位同学的博文C/C++代码审查表进行的设计，具体内容如下：

项目名称	求有向图的所有简单回路
审查人	姚双合	审查日期	2019/4/23
代码名称	源.cpp	代码作者	孙治朝
文件结构
序号	审查项目	重要性	结论	备注
1	头文件和定义文件的名称是否合理？		是
2	头文件和定义文件的目录结构是否合理？		是
3	版权和版本声明是否完整？		不适用	数据结构课程设计，无需版权信息
4	头文件是否使用了 ifndef/define/endif 预处理块?	重要	不适用	未使用自订的头文件
5	头文件中是否只存放“声明”而不存放“定义”？		不适用	未使用自订的头文件
程序版式
序号	审查项目	重要性	结论	备注
6	代码段间的空行是否得体？		是
7	代码行内的空格是否得体？		是
8	长行拆分是否得体？		否	部分较长语句未换行
9	“{” 和 “}” 是否各占一行并且对齐于同一列？		否	"{"并没有单独占一行
10	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	重要	否	部分语句在一行内定义了多个变量
11	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	重要	否	部分只有一句有效语句的判断未加"{}"
12	在定义变量（或参数）时，是否将修饰符 * 和＆紧靠变量名？	重要	不适用	未使用指针变量
13	注释是否清晰并且必要？	重要	不适用	未写注释
14	注释是否没有错误且不会导致误解？	重要	不适用	未写注释
15	类结构的public, protected, private顺序是否在所有的程序中保持一致？	重要	不适用	未使用类
命名规则
序号	审查项目	重要性	结论	备注
16	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	重要	是
17	标识符是否直观且可以拼读？		是
18	标识符的长度应当符合“min-length && max-information”原则？		是
19	程序中是否出现相同的局部变量和全部变量？	重要	是	count变量出现重复、命名相同
20	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？		是
21	静态变量、全局变量、类的成员变量是否加前缀？		否
表达式与基本语句
序号	审查项目	重要性	结论	备注
22	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺	重要	否	双目运算并没有加括号
23	是否编写太复杂或者多用途的复合表达式？		否
24	是否将复合表达式与“真正的数学表达式”混淆？	重要	否
25	是否用正确的方式写if语句? 例如	重要
	1) 将布尔变量直接与TRUE、FALSE或者1、0进行比较。		否
	2) 将浮点变量用“==”或“！=”与任何数字比较。		否	未使用浮点型变量
	3) 将指针变量用“==”或“！=”与NULL比较。		否
26	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体外面？		否
27	Case语句的结尾是加了break？	重要	不适用	未使用switch语句
28	是否写了switch的default分支？	重要	不适用	未使用switch语句
29	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化，重要的计算等。	重要	不适用	未使用goto语句
常量
序号	审查项目	重要性	结论	备注
30	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？		是
31	是否误解了类中的const数据成员？因为const数据成员只在某个对象		不适用	未使用类
32	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	重要	是
33	生存期内是常量，而对于整个类而言却是可变的。		是
函数设计
序号	审查项目	重要性	结论	备注
34	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。		是
35	参数命名、顺序是否合理？		是
36	参数的个数是否太多？		否
37	是否使用类型和数目不确定的参数？		是	使用了指针类型参数与未定义数目的数组参数
38	是否省略了函数返回值的类型？		否
39	函数名字与返回值类型在语义上是否冲突？		否
40	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	重要	否
41	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	重要	否	未使用assert
42	使用滥用了assert？例如混淆非法情况与错误情况，后者是必然存在的并且	重要	否	未使用assert
43	return语句是否返回指向“栈内存”的“指针”或者“引用”？	重要	否
44	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”		否	未使用const
内存管理
序号	审查项目	重要性	结论	备注
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	数据类型问题：	重要
	1) 变量的数据类型有错误吗？		否
	2) 存在不同数据类型的赋值吗？		否
	3) 存在不同数据类型的比较吗？		否
56	变量值问题：	重要
	1) 变量的初始化或缺省值有错误吗？		否
	2) 变量发生上溢或下溢吗？		否
	3) 变量的精度够吗?		是
57	逻辑判断问题：	重要
	1) 由于精度原因导致比较无效吗？		否
	2) 表达式中的优先级有误吗？		否
	3) 逻辑判断结果颠倒吗？		否
58	循环问题：	重要
	1) 循环终止条件不正确吗？		否
	2) 无法正常终止（死循环）吗？		否
	3) 错误地修改循环变量吗？		否
	4) 存在误差累积吗？		否
59	错误处理问题：	重要		未编写错误处理程序
	1) 忘记进行错误处理吗？		不适用
	2) 错误处理程序块一直没有机会被运行？		不适用
	3) 错误处理程序块本身就有毛病吗？		不适用
	4) 错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。		不适用
60	文件I/O问题：	重要		未对文件进行操作
	1) 对不存在的或者错误的文件进行操作吗？		不适用
	2) 文件以不正确的方式打开吗？		不适用
	3) 文件结束判断不正确吗？		不适用
	4) 没有正确地关闭文件吗?		不适用

3.评价

孙治朝同学是一名非常优秀的同学，他的编程能力毋庸置疑；同时他的代码风格也十分严谨，不会让人有“什么也看不懂”的感觉。但是人无完人，孙治朝同学也还是有需要提升的地方，所以，优点缺点我都会提到。

优点

首先，他的代码结构很清晰，功能函数与主函数之间能完全区分开；代码的风格也是简明，易读，不会产生二义性。对于首行缩进，统一都是四个空格，这样看起来逻辑结构很明了。变量和函数的命名也是符合规范，并不是为了简单而随意命名。对于程序边界情况的处理也是十分得当，考虑了程序运行到边界条件的安全性。

缺点

优点很多，同时缺点也不算少。对于{ }的使用，代码中并没有让{括号单独占一行，所以在判断for循环时，对于循环体的审查就不是很明显了，例如：

    for (int i = 1; i <= G.arcnum; i++) {
        printf("请输入第%d条边: ", i);
        cin >> c1 >> c2;
        int num1 = Locate_num(G, c1);
        int num2 = Locate_num(G, c2);
        InsertEdge(G, num1, num2);
    }

如果将{括号单独分为一行的话，看上去就能更清晰易读。对于循环体只有一条语句和if判断之后只有一条执行语句的部分，都没有添加{ }括号，这对于代码风格来说不算是好的，审查代码时并不清晰，希望孙治朝同学今后能注意到这个问题。
代码之中基本没有相关的注释。这同时也是我的毛病，当初写完的代码，都能看都是怎么写的，过了一段时间之后再去看，好多细节部分都已经记不清了，所以写注释是一个非常好的习惯，这方面，我和孙治朝同学都需要改进。
对于内存的分配，并没有使用动态内存分配，如果可以实现的话，对于程序的优化将起到非常大的帮助。

总之，孙治朝同学的代码风格很不错，需要注意的地方提高之后，将会是以为非常好的合作伙伴。

转载于:https://www.cnblogs.com/Carlos-Yao/p/10756683.html