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

一.代码地址

这个小程序是徐子健同学在早些时候学习过程种编写的，是一个用c实现的学生成绩管理系统，项目的Coding地址：代码
该同学的博客地址：YELLOWCARD的博客

二.代码审查

项目名称	成绩管理系统
审查人	王文博	审查日期	2019/4/25
代码名称	源.c	代码作者	徐子健
文件结构
序号	审查项目	重要性	结论	备注
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	程序中是否出现相同的局部变量和全部变量？	重要	否
20	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？		是
21	静态变量、全局变量、类的成员变量是否加前缀？		否
表达式与基本语句
序号	审查项目	重要性	结论	备注
22	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺	重要	是
23	是否编写太复杂或者多用途的复合表达式？		是	多次使用
24	是否将复合表达式与“真正的数学表达式”混淆？	重要	否
25	是否用正确的方式写if语句? 例如	重要
	1) 将布尔变量直接与TRUE、FALSE或者1、0进行比较。		否
	2) 将浮点变量用“==”或“！=”与任何数字比较。		否	未使
	3) 将指针变量用“==”或“！=”与NULL比较。		否
26	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体外面？		否
27	Case语句的结尾是加了break？	重要	是
28	是否写了switch的default分支？	重要	否
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) 没有正确地关闭文件吗?		不适用

三.评价

我同伴的程序操作是建立成绩管理，以达到查询、删除学生成绩学生成绩并按照按平均成绩排序等功能，代码格式规范，但是还是有些许问题。
优点：
1.。
2.代码整体结构清晰，格式整齐代码，如“{” 和 “}” 各占一行并且对齐于同一列。
3.参数的书写完整，没有图省事只写参数的类型而省略参数名字。
4.代码简洁。
缺点：
1.使用exit函数强制退出。
2.大量使用system("cls");语句清屏
3.为追求代码简介大量使用复合语句，如在循环中定义变量等。

for (int num = *n - 1; num >= 0; num--)
	{
		printf("\t学生学号：%s\n\t语文成绩：%3.1f\n\t数学成绩：%3.1f\n\t英语成绩：%3.1f\n\t平均成绩：%3.1f\n\n", student[num].num, student[num].Chinese, student[num].Math, student[num].English, student[num].Average);
	}
	getch();
	system("cls");

四.总结

本次作业我懂了代码审查的重要性，两个人总比一个人想的周全，正是因为看问题的角度不一样才更容易发现BUG并找到更简单有效的解决方案。所谓旁观者清就是这个道理。审查代码不是代表你比被人弱，而是找出他容易忽视的小问题。
更又利于自己和他人编程水平的提高。