软件工程第三次作业

博客信息	沈阳航空航天大学计算机学院2020软件工程作业
作业要求	click on me
课程目标	熟悉一个“高质量”软件的开发过程
作业目标	熟悉代码规范及结对互审

一、Code introduction

---

结对伙伴的小学四则运算自动生成程序功能如下：
(1)能够自动生成四则运算练习题;
(2)可以定制题目数量;
(3)用户可以选择运算符;
(4)用户设置最大数（如十以内、百以内等）;
(5)用户选择是否有括号、是否有小数;
(6)用户选择输出方式（如输出到文件、打印机等）。

二、Rrview form

---

功能模块名称		四则运算生成系统
审查人		王锐	审查日期	2020-4-12
代码作者		孙喜伦	代码地址	code
序号	重要性	审查项		结论
文件结构
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语句？例如 （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 （2）将浮点变量用“==”或“！=”与任何数字比较。 （3）将指针变量用“==”或“！=”与NULL比较。		否
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的语句是否正确无误？		无
C++函数的高级特性
55	不重要	重载函数是否有二义性？		无
56	重要	是否混淆了成员函数的重载、覆盖与隐藏？		无
57	不重要	运算符的重载是否符合制定的编程规范？		无
58	不重要	是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。		无
59	重要	是否用内联函数取代了宏代码？		无
其他常见问题
60	重要	数据类型问题： （１）变量的数据类型有错误吗？ （２）存在不同数据类型的赋值吗？ （３）存在不同数据类型的比较吗？		否
61	重要	变量值问题： （１）变量的初始化或缺省值有错误吗？ （２）变量发生上溢或下溢吗？ （３）变量的精度够吗？		否
62	重要	逻辑判断问题： （１）由于精度原因导致比较无效吗？ （２）表达式中的优先级有误吗？ （３）逻辑判断结果颠倒吗？		否
63	重要	循环问题： （１）循环终止条件不正确吗？ （２）无法正常终止（死循环）吗？ （３）错误地修改循环变量吗？ （４）存在误差累积吗？		否
64	重要	错误处理问题： （１）忘记进行错误处理吗？ （２）错误处理程序块一直没有机会被运行？ （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。		无
65	重要	文件I/O问题： （１）对不存在的或者错误的文件进行操作吗？ （２）文件以不正确的方式打开吗？ （３）文件结束判断不正确吗？ （４）没有正确地关闭文件吗?		无

三、Comment

---

  首先，从代码的整体看，排版不是特别好，空行没有处理好，导致从整体看来有点乱。从代码的功能来看基本实现了四则运算生成的功能。从代码规模看，代码规模不大，仅有142行，不过功能基本齐全，不过在一些细节方面没有处理的很好，比如输入其他非法字符就会陷入死循环，不能提示重新输入等。

  其次，既然是代码互审，主要就是能够发现小伙伴代码中的不足，所以我主要说一下伙伴代码不到位的地方，希望小伙伴能够在代码互审从中吸取到一些有用的东西，共同进步。从代码的可读性来看，可读性一般。在函数以及变量的命名上不直观，仅用简单的字符进行命名，不能直观的看出函数及变量的用途，希望能偶换成英文单词。然后，这份代码仅能执行生成一次，用户运行一次后，只能重新进行运行，不能循环执行。还有一些小的功能没有实现，比如在输入非法字符或者错误输入时不能报错。，没有对文件的写入功能。然后在代码的功能实现上，尽量用函数进行封装，然后通过主函数调用，这样便于结构清晰，增强代码的可读性。

  然后，总体来说这份代码完成的质量还是不错的，可以较好的完成功能的需求，但是对于题目之外的扩展较少，代码不美观，注释不明确或者没有注释。在团队作业中，注释的书写对于团队之间的交流是很重要的，是团队之间沟通的一个重要方式，希望在以后能够完善代码可读性及注释的书写。

  最后，希望代码互审能够找出我们自己的不足，以便今后更好的前行。

ps:w3school