软件工程第二次结队编程

Posted 2021-11-26 pandadalin

领航员——对代码的评测

一 题目要求

我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：

• 能够自动生成四则运算练习题
• 可以定制题目数量
• 用户可以选择运算符
• 用户设置最大数（如十以内、百以内等）
• 用户选择是否有括号、是否有小数
• 用户选择输出方式（如输出到文件、打印机等）
• 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）

二 队友的代码

GitHub 代码链接[https://github.com/leex404/-Calculation]

三 代码评测表

功能模块名称	二叉树遍历的非递归实现
审查人	李宏达	审查日期	2019.4.30
代码名称	自动生成四则运算程序	代码作者	李鑫
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	合理
	头文件和定义文件的目录结构是否合理？	合理
	版权和版本声明是否完整？	完整
重要	头文件是否使用了 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问题：
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

四 代码进行单元自动测试

浏览代码，从中选择了一个关键函数进行单元测试
代码如下：

static std::string roundAny(float r, int precision) {

std::stringstream buffer;

buffer << std::fixed << std::setprecision(precision) << r;

return buffer.str();

 }

设计测试用例，进行测试，测试代码如下：

namespace Unitcalculation
{       
 TEST_CLASS(UnitTest1)
    {
        public:
    
    TEST_METHOD(TestMethod1)
    {
        // TODO: 在此输入测试代码
        std::string buffer;
        float number;
        number = 12.3256;
        buffer = "12.33";
        Assert::AreEqual(buffer, roundAny(number, 2));
        
    }
    TEST_METHOD(TestMethod2)
    {
        // TODO: 在此输入测试代码
        std::string buffer;
        float number;
        number = 12.121362316;
        buffer = "12.121";
        Assert::AreEqual(buffer, roundAny(number, 3));

    }
    TEST_METHOD(TestMethod3)
    {
        // TODO: 在此输入测试代码
        std::string buffer;
        float number;
        number = 163.1113131;
        buffer = "163.11131";
        Assert::AreEqual(buffer, roundAny(number, 5));

        }
    };
}

测试运行结果全部正确，测试结果如图所示

进行程序测试：
（1）10以内，有+，-运算，有括号，无小数进行生成，运行如下

(2) 100以内，有+，- , * , /运算，有括号，有小数进行生成，运行如下

(3) 50以内，有+, * , 运算，无括号，没有小数进行生成，运行如下

五 评价与总结

1.评价
代码的缺点

• 一行代码没有只定义一条语句
• if语句后面没有加足够的{}
  

代码的优点

• 运行效率高，复杂度低
• 代码简洁，思路清晰
• 变量命名规范，能一下子知道存储的类型
• 在功能上没有问题，程序运行正确
  ??在审查过程中，审查表覆盖的审计很全，根据审查表的顺序，从上到下对代码进行了仔细的审查，先对代码整体格式进行了浏览，之后对逐行代码进行审查，也发现了些问题，这些问题也是自己所经常犯得错误，比如对每行的代码并没有只是一个语句，对括号使用不足。
  ??代码遵循了code style规范中大部分的细节，考虑了边界情况，在特殊处理的地方，写详细的注释，代码适用于各种C++语言编译平台，采用了新的技术，新的方法，新的创新。代码中没有发现bug。
  ??代码规模小，执行效率高，占用空间小， 可读性强， 扩展性强，这对后面的评测有很大的减轻作用。模块划分清楚，代码分为结构体定义，随机数生成，增添括号，随机小数，运算符号的挑选，每个模块清晰易读，简洁而完整。

2.总结

   之前我和李鑫同学已经合作过，在之前的操作系统课程设计中，我们俩的默契就很好，通过这次的设计，我们的默契又进一步加强，本次设计，我作为领航员，他作为驾驶员，我虽然没有动手操作，但我参与对思路的构建和想法的创新，对bug的修正等相关操作，刚开始，李鑫同学就编写了对算数数目，符号的挑选能自动生成算数题，之后我帮助他完善了产生随机小数，对小数字寛的设施，括号的添加，生成文本文件等功能，经历大约4小时（其中有玩的时间）完成了这次任务，其中印象最深的是对括号位置的添加，最左与最右的括号不能同时添加，他写成了不能在最左和最右添加括号，这样逻辑就错了，我及时指出，最终修复了这个bug。
   对于本次工作，我们认真的完成了这个题目，也对一些难点的攻克，但还是有一些问题，本来我们做页面的，用C#语言，由于对C#语言涉及不多，最终放弃这个想法，由于开始用到C++语言，无法用别的语言去做，等有时间的话，会用别的语言重新完善这个功能。
   对于驾驶员的总结，很高兴能和他一起合作，我们俩能够有很好的沟通，对问题也会仔细讨论，一起去解决，省去了很多不必要的麻烦，节省了很多时间，他有很好的编程能力，这次他很辛苦进行代码的编写，下次我们俩的工作进行互换，来进行合作。这次合作很愉快。