软件工程第三次作业

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

代码地址

数学速算软件

C++代码审查表

功能模块名称
审查人	吴浩程	审查日期	4.12
代码名称	数学速算软件.cpp	代码作者	邢梓桐
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	是
	头文件和定义文件的目录结构是否合理？	是
	版权和版本声明是否完整？	否
重要	头文件是否使用了 ifndef/define/endif 预处理块?	否
	头文件中是否只存放“声明”而不存放“定义”	是
程序的版式
重要性	审查项	结论
	空行是否得体？	是
	代码行内的空格是否得体？	是
	长行拆分是否得体？	无长行
	“{” 和 “}” 是否各占一行并且对齐于同一列？	是
重要	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	是
重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	是
重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	是
重要	注释是否有错误或者可能导致误解？	否
重要	类结构的public, protected, private顺序是否在所有的程序中保持一致？	无类结构
命名规则
重要性	审查项	结论
重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
	标识符是否直观且可以拼读？	是
	标识符的长度应当符合“min-length && max-information”原则？	是
重要	程序中是否出现相同的局部变量和全部变量？	否
	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是
	静态变量、全局变量、类的成员变量是否加前缀？	是
表达式与基本语句
重要性	审查项	结论
重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	无
	是否编写太复杂或者多用途的复合表达式？	无
重要	是否将复合表达式与“真正的数学表达式”混淆？	无
重要	是否用隐含错误的方式写if语句? 例如
	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	否
	（2）将浮点变量用“==”或“！=”与任何数字比较。	否
	（3）将指针变量用“==”或“！=”与NULL比较。	否
	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判
	断移到循环体的外面？	是
重要	Case语句的结尾是否忘了加break？	否
重要	是否忘记写switch的default分支？	否
重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	否
常量
重要性	审查项	结论
	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	否
	在C++ 程序中，是否用const常量取代宏常量？	无
重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	是
	是否误解了类中的const数据成员？因为const数据成员只在某个对象	无
	生存期内是常量，而对于整个类而言却是可变的。	无
函数设计
重要性	审查项	结论
	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
	参数命名、顺序是否合理？	是
	参数的个数是否太多？	否
	是否使用类型和数目不确定的参数？	否
	是否省略了函数返回值的类型？	否
	函数名字与返回值类型在语义上是否冲突？
重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否
重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	否
重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	否
重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？	否
	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	否
内存管理
重要性	审查项	结论
重要	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）	未申请内存
重要	是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	否
重要	数组或指针的下标是否越界？	否
重要	动态内存的申请与释放是否配对？（防止内存泄漏）	未申请内存
重要	是否有效地处理了“内存耗尽”问题？	未申请内存
重要	是否修改“指向常量的指针”的内容？	否
重要	是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。	否
重要	是否将malloc/free 和 new/delete 混淆使用？	否
重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	未申请内存
重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	未申请内存
C++ 函数的高级特性
重要性	审查项	结论
	重载函数是否有二义性？	无
重要	是否混淆了成员函数的重载、覆盖与隐藏？	无
	运算符的重载是否符合制定的编程规范？	无
	是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。	无
重要	是否用内联函数取代了宏代码？	无
类的构造函数、析构函数和赋值函数
重要性	审查项	结论
重要	是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数：
否	（1）缺省的无参数构造函数；
	（2）缺省的拷贝构造函数；
	（3）缺省的析构函数；
	（4）缺省的赋值函数。
重要	构造函数中是否遗漏了某些初始化工作？	否
重要	是否正确地使用构造函数的初始化表？	无构造函数
重要	析构函数中是否遗漏了某些清除工作？	无析构函数
	是否错写、错用了拷贝构造函数和赋值函数？	否
重要	赋值函数一般分四个步骤：
	（1）检查自赋值；
	（2）释放原有内存资源；
	（3）分配新的内存资源，并复制内容；
	（4）返回 *this。是否遗漏了重要步骤？	否
重要	是否正确地编写了派生类的构造函数、析构函数、赋值函数？	无派生类
	注意事项：
	（1）派生类不可能继承基类的构造函数、析构函数、赋值函数。
	（2）派生类的构造函数应在其初始化表里调用基类的构造函数。
	（3）基类与派生类的析构函数应该为虚（即加virtual关键字）。
	（4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值
类的高级特性
重要性	审查项	结论
重要	是否违背了继承和组合的规则？	无继承和组合
	（1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。
	（2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。
其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？
否	（２）存在不同数据类型的赋值吗？
否	（３）存在不同数据类型的比较吗？	否
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？
否	（２）变量发生上溢或下溢吗？	否
	（３）变量的精度够吗？	是
重要	逻辑判断问题：
	（１）由于精度原因导致比较无效吗？	否
	（２）表达式中的优先级有误吗？	否
	（３）逻辑判断结果颠倒吗？	否
重要	循环问题：
	（１）循环终止条件不正确吗？	否
	（２）无法正常终止（死循环）吗？	否
	（３）错误地修改循环变量吗？	否
	（４）存在误差累积吗？	否
重要	错误处理问题：
	（１）忘记进行错误处理吗？	是
	（２）错误处理程序块一直没有机会被运行？	否
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	否
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	否
重要	文件I/O问题：
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

对Partner代码的评价

 本次结对同伴的作品是采用C语言编写的数学速算测试程序。该程序实现的主要是按提示可使用该程序进行的速算测试，可以逐题进行判断对错，可以判断加减、乘除、加减乘除随机题目输入答案的正确性，以及计算做题时间。整体代码设计比较符合代码审查表中的标准，代码结构、版式以及表达式等语句基本符合标准规范，但经过测试以及审查代码还是发现了代码其中有些小问题解决的不够好，如果能完善就很好。

 首先对于变量名方面，为方便审查代码时读代码可以将变量名用其实际用途来命名，比如初级加减法运算函数primary：

int i,a,b,sum,sum1,pol,poo=0,a1,b1,c1;
int oor;

 注释中有写a、b为加数和被加数以及其他变量名的含义，但我觉得不妨将变量名a、b写成Addend_First和Addend_second，这样就不用用注释来介绍变量的含义，这样可以提高代码的可读性和可维护性。

 对于菜单界面函数menu的代码设计，作者运用if语句来实现功能选择，我觉得这种选择可以采用switch语句来实现，不过使用switch语句的时候要注意按照标准，既要有break语句，而且需要用default分支，来防止有错误操作导致的程序崩溃等问题。

 对于代码界面函数menu的循环方面，menu函数中是这样写的：

void menu()
{
    cout<<"欢迎使用数学速算自我训练软件"<<endl;
    cout<<"请选择训练等级："<<endl;
    cout<<"1、初级"<<endl<<"2、中级"<<endl<<"3、高级"<<endl<<"4、查看排行"<<endl<<
"5、重置排行"<<endl<<"请输入数字序号"<<endl; 
    int a;
    while(1)
    {
	    cin>>a;
	    if(a==1)
	    {
		    primary();
		    break;
	    }
	    else if(a==2)
	    {
		    intermediate();
		    break;
	    }
	    else if(a==3)
	    {
		    senior();
		    break;
	    }
	    else if(a==4)
	    {
		    look();
		    break;
	    }
	    else if(a==5)
	    {
		    del();
		    break; 
	    }
	    else
		    cout<<"请重新输入！"<<endl;
    }

}

 menu函数中使用了while(1)循环，用于多次反复进行出题答题和答案判断的运行流程，但是作者将难度选择的部分放进了循环的内部，这样会产生菜单的重叠，但是作者用过书写clean_1函数调用system("cls");在每次做完题后对屏幕进行清理，使得交互界面整洁，人机交互好，这里处理的比较好。

 还有在加减和乘除运算中，只设计了a+b、a-b、a*b、a/b四种形式的运算，应当在其中加入混合运算，不局限于一个计算的格式能使得功能性更好。

 在随机算式中的随机数生成方面，我觉得应当使产生随机数更合理随机些。如若只是用语句“rand()%100“来生成随机数的话，会使每次运行程序时生成的随机数序列相同，导致每次运行程序时产生的算式都是一样的问题，从而使该程序失去其随机测验的意义。我建议应当通过系统时间的数字来作为初始化随机数的种子，这样处理就不会产生重复的随机数，进一步完善程序的功能性。

 以上就是个人的拙见，做题上来说代码功能实现的还是很不错，大体问题都能考虑到，如果在注意一下一些代码设计的细节和合理性会更好。

（1）优点
注释较为详细，代码书写整齐规范；
各个函数设置合理，功能分工明确，易读。
（2）不足
变量名存在不以含义命名的地方；
错误处理不够完善，对于错误的数据类型没有提示；
界面设计单一。

总结

通过这次代码复审，我对于代码可读性的认识深刻，一个好的代码的可读性一定是易读的；
通过C++代码审查表学习到了编写代码的基本规范；
审阅他人的代码有助于发现自己编写代码时的不足，尤其是错误处理考虑不够周全；
通过代码复审在检查同伴代码，能够提高相互的代码水平。