Software engineering third job pairing for the first time

The third job of software engineering

Blog information	Shenyang University of Aeronautics and Astronautics, School of Computer Engineering 2020 Software Engineering
Work requirements	https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616
Course objectives	Familiar with the development process of a "high quality" software
Homework goal	Familiar with code specifications and pair-wise mutual review

1. Companion information

My companion is Jiang Haonan

2. Audit form

Function module name	Multi-function calculator (including subtraction, multiplication and division, and decimal to N)
Examiner	Zhu Guoyu	Review date	2020/4/12
Code name	Multifunction calculator	Code author	Jiang Haonan
File structure
importance	Review item	in conclusion
	Are the names of the header and definition files reasonable?	Yes
	Whether the directory structure of header files and definition files is reasonable	Yes
	Are the copyright and version statements complete?
	Does the header file use ifndef / define / endif preprocessing blocks?	no
	Whether to only store "declaration" but not "definition" in the header file	no
The format of the program
importance	Review item	in conclusion
	Is the blank line decent?	Yes
	Whether the space in the code line is decent	no
	Is the long line split decent?	Yes
	Do "{" and "}" occupy one row each and are aligned in the same column?	Yes
important	Does one line of code only do one thing? If only one variable is defined, write only one statement.	no
important	If, for, while, do and other statements are on their own line, "{}" must be added no matter how many statements are executed.	no
important	When defining a variable (or parameter), are the modifiers * and & next to the variable name? Are the comments clear and necessary?	Yes
important	Are there any errors in the comments or may cause misunderstandings?	no
important	Are the public, protected, and private order of the class structure consistent in all programs	Yes
Naming convention
importance	Review item	in conclusion
important	Is the naming convention consistent with the style of the operating system or development tool used?	Yes
	Is the identifier intuitive and spellable?	Yes
	Should the length of the identifier conform to the "min-length && max-information" principle?	Yes
important	Do the same local variables and all variables appear in the program?	no
	Do class names, function names, variables and parameters, and constants follow certain rules?	Yes
	Are static variables, global variables, and class member variables prefixed?	no
Expressions and basic sentences
importance	Review item	in conclusion
important	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	是
	是否编写太复杂或者多用途的复合表达式？	否
重要	是否将复合表达式与“真正的数学表达式”混淆？	否
重要	是否用隐含错误的方式写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）缺省的赋值函数。
重要	（4）缺省的赋值函数。
重要	构造函数中是否遗漏了某些初始化工作？	否
重要	是否正确地使用构造函数的初始化表？	是
重要	析构函数中是否遗漏了某些清除工作？	否
	是否错写、错用了拷贝构造函数和赋值函数？	否
重要	赋值函数一般分四个步骤：
	（1）检查自赋值；
	（2）释放原有内存资源；
	（3）分配新的内存资源，并复制内容；
	（4）返回 *this。是否遗漏了重要步骤？	否
重要	是否正确地编写了派生类的构造函数、析构函数、赋值函数？	是
	注意事项：
	（1）派生类不可能继承基类的构造函数、析构函数、赋值函数。
	（2）派生类的构造函数应在其初始化表里调用基类的构造函数。
	（3）基类与派生类的析构函数应该为虚（即加virtual关键字）。
	（4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值
类的高级特性
重要性	审查项	结论
重要	是否违背了继承和组合的规则？	否
	（1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。
	（1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。	（2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。
	其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？	否
	（２）存在不同数据类型的赋值吗？	否
	（３）存在不同数据类型的比较吗？	否
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？	否
	（２）变量发生上溢或下溢吗？	否
	（３）变量的精度够吗？	否
重要	逻辑判断问题：
	（１）由于精度原因导致比较无效吗？	否
	（２）表达式中的优先级有误吗？	否
	（３）逻辑判断结果颠倒吗？	否
重要	循环问题：
	（１）循环终止条件不正确吗？	否
	（２）无法正常终止（死循环）吗？	否
	（３）错误地修改循环变量吗？	否
	（４）存在误差累积吗？	否
重要	错误处理问题：
	（１）忘记进行错误处理吗？	否
	（２）错误处理程序块一直没有机会被运行？	否
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	否
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	否
重要	文件I/O问题：
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

三. 对同伴的代码评价

我同伴姜皓南写的计算器和进制转换计算器简洁，工整，代码间有空格，所有括号和空格全都对齐了，看起来观感非常好，让
人心情愉悦。把能想到的特殊情况都写了上去，比如在计算器运行时，输入了其他的字符，这时会提示你输入的不对，在除法的
时候，你输入除数为0，会提示你除数不能为0，在进制转换的时候，考虑到了十进制以上的情况，将得到的数转换成A，B，C，D，
E，考虑的非常周到。在变量的命名和函数的命名方面都很不错，运用的变量和函数的命名都非常让人一眼就能看懂，期间运行时
提示的汉字让人感到操作起来很轻松，不困难，知道下一步要干什么，代码看起来非常舒服。再开始界面会有汉字提示你计算器
拥有的功能，而在结束的界面还有欢迎使用计算器，非常细心。在下面总结优点与缺点。
优点有：
（1）代码十分整洁，括号和空格全都上下对齐了，看起来心情舒畅。
（2）在开始的界面提示有什么功能，在运行过程中提示你如何进行下一步操作，在结束的界面还有提示。
（3）在进行输入的时候，输入其他错误的字符会提示你错误操作，非常细心，将能想到的特殊情况都写了出来。
缺点有：
（1）功能可以再增加一些，比如可以进行2个以上的加减乘除，比如2+3*5，这得考虑到符号优先级，又可以再写许多行
（2）在开始的界面有文字的提示，可以增加一些其他的图案，让开始的界面更美观。
（3）if后面只有一条语句，按道理可以不加大括号，我感觉还是加上比较好。

四. 心得

这次结对作业让我学会了如何进行合作进行玩成任务，以及如何根据代码审查表进行审查代码的内容，对以后进行书写代码有很大
的帮助。也让我和我的队友有了更多的交流，互相帮助,共同进步。