2020软件工程第四次作业
| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10685 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
一、题目
我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：
能够自动生成四则运算练习题
可以定制题目数量
用户可以选择运算符
用户设置最大数（如十以内、百以内等）
用户选择是否有括号、是否有小数
用户选择输出方式（如输出到文件、打印机等）
最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）
二、任务分工
驾驶员：李云洲
领航员：陈明玮
三、设计原型
四、合作照片
五、驾驶员的代码地址
https://github.com/selfdefine/2020SWEH/tree/master/it_pupil_04_arithmetic_auto_generate
六、关键函数
七、单元测试如下
八、代码检查表
| 序号 | 重要性 | 审查项 | 结论 |
|---|---|---|---|
| 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语句? | 是 |
| 25 | 重要 | Case语句的结尾是否忘了加break？ | 是 |
| 26 | 重要 | 是否忘记写switch的default分支？ | 是 |
| 27 | 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无 |
| 28 | 不重要 | 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 |
| 29 | 不重要 | 在C++ 程序中，是否用const常量取代宏常量？ | 无 |
| 30 | 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 |
| 31 | 不重要 | 是否误解了类中的const数据成员？ | 无 |
| 32 | 不重要 | 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 |
| 33 | 不重要 | 参数命名、顺序是否合理？ | 是 |
| 34 | 不重要 | 参数的个数是否太多？ | 是 |
| 35 | 不重要 | 是否使用类型和数目不确定的参数？ | 是 |
| 36 | 不重要 | 是否省略了函数返回值的类型？ | 是 |
| 37 | 不重要 | 函数名字与返回值类型在语义上是否冲突？ | 是 |
| 38 | 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 |
| 39 | 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 |
| 40 | 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 无 |
| 41 | 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 是 |
| 42 | 不重要 | 是否使用const提高函数的健壮性 | 否 |
| 43 | 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 无 |
| 44 | 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 是 |
| 45 | 重要 | 数组或指针的下标是否越界？ | 是 |
| 46 | 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 无 |
| 47 | 重要 | 是否有效地处理了“内存耗尽”问题？ | 无 |
| 48 | 重要 | 是否修改“指向常量的指针”的内容？ | 无 |
| 49 | 重要 | 是否出现野指针？ | 无 |
| 50 | 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 无 |
| 51 | 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正确？ | 无 |
| 52 | 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 无 |
| 53 | 不重要 | 重载函数是否有二义性？ | 无 |
| 54 | 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | 无 |
| 55 | 不重要 | 运算符的重载是否符合制定的编程规范？ | 是 |
| 56 | 不重要 | 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 | 是 |
| 57 | 重要 | 是否用内联函数取代了宏代码？ | 无 |
| 58 | 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： | 无 |
| 59 | 重要 | 构造函数中是否遗漏了某些初始化工作？ | 无 |
| 60 | 重要 | 是否正确地使用构造函数的初始化表？ | 无 |
| 61 | 重要 | 析构函数中是否遗漏了某些清除工作？ | 无 |
| 62 | 不重要 | 是否错写、错用了拷贝构造函数和赋值函数？ | 无 |
| 63 | 重要 | 赋值函数一般分四个步骤，是否遗漏了重要步骤 | 无 |
| 64 | 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数？ | 无 |
| 65 | 重要 | 是否违背了继承和组合的规则？ | 无 |
| 66 | 重要 | 数据类型问题： | 是 |
| 67 | 重要 | 变量值问题： | 是 |
| 68 | 重要 | 逻辑判断问题： | 是 |
| 69 | 重要 | 循环问题 | 是 |
| 70 | 重要 | 错误处理问题 | 是 |
| 71 | 重要 | 文件I/O问题： | 是 |
九、工作记录表
| 项目 | 预计 | 实际 |
|---|---|---|
| 设计时间 | 1h | 1.5h |
| 编码时间 | 6h | 8h |
| 测试时间 | 3.5h | 3h |
| 代码行数 | 500 | 352 |
| 测试代码行数 | 100 | 92 |
| 错误数量 | 0 | 2 |
| 错误修复时间 | 0.5h | 1h |
| 开发总时间 | 11h | 14.5h |
十、总结
本次工作驾驶员做的很好，能力比较强，编写代码的思路和速度也特别好，然后关于我用墨刀做的原型，驾驶员也领会的特别到位，合作过程中通过屏幕分享我也对驾驶员编写代码过程中的小马虎和小错误给予了指正，驾驶员也比较耐心，接受我的建议，意见没有分歧，总之，合作还是比较愉快的。
十一、评价
本次工作以结对方式完成，我担任领航员的角色，首先我用老师安利好多次的快速原型工具墨刀画出来了原型，然后通过屏幕分享辅助驾驶员完成全部代码工作，合作过程中也体现了我的细心以及同伴的编码能力，同伴的编码能力很强，这次合作过程中，不仅学会与人好好合作多沟通多表达多接受，而且也学到了很多知识，进一步锻炼了自己的能力，我为关键函数选用合适的覆盖标准设计测试用例，，并编写代码进行单元自动测试，途中也遇到了很多问题，不过后来都解决了，因为有了第二次结对编程的经验，我很快的完成了代码的审查，并在进行单元测试时也很快的实现，在编写代码时也向驾驶员进行了请教，完善了单元测试代码的编写。此次结对编程作业使我意识到了团队协作的重要性，一个人的力量是有限的，在进行任务的过程中会出现思路不全面的情况，进度相对来说也会慢一些，而团队合作不仅不会出现这样的问题，还会提高两人的交流沟通能力，相互学习更好地完成任务。希望在接下来的团队作业中，可以发现自己其他方面的不足并加以改正，学到更多。
也希望在以后的学习中，能够提升自己的能力，将代码做到尽善尽美。在于我的队友交流时，发现自身不足，虽然这是最后一次结对编程，但希望以后还能有这种机会。这次合作特别愉快，希望大家的能力都有所提升
