软件工程(2019)第二次结队作业

一、题目要求

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

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

二、角色分配

  • 驾驶员:徐子健(负责全部主要代码编写)
  • 领航员:王文博 (负责协助驾驶员完成全部代码的编写,并完成代码的测试工作)

三、代码复审

项目名称 小学四则运算自动生成器
审查人 王文博 审查日期 2019/5/3
代码名称 main.cpp 代码作者 徐子健
文件结构
序号 审查项目 重要性 结论 备注
1 头文件和定义文件的名称是否合理? 重要  
2 头文件和定义文件的目录结构是否合理?    
3 版权和版本声明是否完整?   完整
4 头文件是否使用了 ifndef/define/endif 预处理块? 不适用 未使用自己定义的头文件
5 头文件中是否只存放“声明”而不存放“定义”?   不适用 未使用自己定义的头文件
程序版式
序号 审查项目 重要性 结论 备注
6 代码段间的空行是否得体?    
7 代码行内的空格是否得体?  
8 长行拆分是否得体?  
9 “{” 和 “}” 是否各占一行并且对齐于同一列?  
10 一行代码是否只做一件事?如只定义一个变量,只写一条语句。 重要 部分语句一行进行很多操作
11 If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 重要
12 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名? 重要
13 注释是否清晰并且必要? 重要 足够简单清晰
14 注释是否没有错误且不会导致误解? 重要
15 类结构的public, protected, private顺序是否在所有的程序中保持一致? 重要 不适用 未使用类解构
命名规则
序号 审查项目 重要性 结论 备注
16 命名规则是否与所采用的操作系统或开发工具的风格保持一致? 重要
17 标识符是否直观且可以拼读?    
18 标识符的长度应当符合“min-length && max-information”原则?    
19 程序中是否出现相同的局部变量和全部变量? 重要
20 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则?    
21 静态变量、全局变量、类的成员变量是否加前缀?    
表达式与基本语句 
序号 审查项目 重要性 结论 备注
22 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序 重要
23 是否编写太复杂或者多用途的复合表达式?  
24 是否将复合表达式与“真正的数学表达式”混淆? 重要  
25 是否用正确的方式写if语句? 例如 重要    
1) 将布尔变量直接与TRUE、FALSE或者1、0进行比较。  
2) 将浮点变量用“==”或“!=”与任何数字比较。 未使用
3) 将指针变量用“==”或“!=”与NULL比较。  
26 如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判断移到循环体外面?    
27 Case语句的结尾是加了break? 重要 不适用 未使用switch语句
28 是否写了switch的default分支? 重要
29 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化,重要的计算等。 重要 不适用 未使用goto语句
常量
序号 审查项目 重要性 结论 备注
30 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串?    
31 是否误解了类中的const数据成员?因为const数据成员只在某个对象   不适用 未使用类
32 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? 重要  
33 生存期内是常量,而对于整个类而言却是可变的。   不适用 未使用类
函数设计
序号 审查项目 重要性 结论 备注
34 参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。    
35 参数命名、顺序是否合理?    
36 参数的个数是否太多?    
37 是否使用类型和数目不确定的参数?   使用了随机数
38 是否省略了函数返回值的类型?    
39 函数名字与返回值类型在语义上是否冲突?    
40 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 重要 不使用 未使用正确,错误标志
41 在函数体的“入口处”,是否用assert对参数的有效性进行检查? 重要 不适用 未使用assert
42 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且 重要 不适用 未使用assert
43 return语句是否返回指向“栈内存”的“指针”或者“引用”? 重要  
44 是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need”   未使用const
内存管理
序号 审查项目 重要性 结论 备注
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的语句是否正确无误? 重要 不适用 未使用动态对象数组
其它常见问题 
序号 审查项目 重要性 结论 备注
55 数据类型问题: 重要    
1) 变量的数据类型有错误吗?  
2) 存在不同数据类型的赋值吗?  
3) 存在不同数据类型的比较吗?  
56 变量值问题: 重要    
1) 变量的初始化或缺省值有错误吗?  
2) 变量发生上溢或下溢吗?  
3) 变量的精度够吗?  
57 逻辑判断问题: 重要    
1) 由于精度原因导致比较无效吗?  
2) 表达式中的优先级有误吗?  
3) 逻辑判断结果颠倒吗?   
58 循环问题: 重要    
1) 循环终止条件正确吗?  
2) 无法正常终止(死循环)吗?  
3) 错误地修改循环变量吗?  
4) 存在误差累积吗?  
59 错误处理问题: 重要   未编写错误处理程序
1) 忘记进行错误处理吗?
2) 错误处理程序块一直没有机会被运行?
3) 错误处理程序块本身就有毛病吗?
4) 错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。
60 文件I/O问题: 重要  
1) 对不存在的或者错误的文件进行操作吗?
2) 文件以不正确的方式打开吗?
3) 文件结束判断不正确吗?
4) 没有正确地关闭文件吗?

四·、程序测试

  • 程序运行结果如下

五、总结

  • 我们选择的课题是四则运算,看似比较的简单,实际有许多关键点。其中就例如怎么生成随机数和随机符号等。其实在课上老师提到这个问题时,我们就关注了这个问题,这个问题听起来很简单,做起来却很繁琐,代码量很大,驾驶员的工作很重也很累。后来徐子健同学承担了驾驶员的任务,负责主要代码的编写,我负责从旁协助。徐子健同学很尽责任,通过共同努力最后成功完成任务。
    在这次工作中,也存在一点小问题,就是代码的格式有些乱,编写完成之后没精力再去优化整洁一下代码。还有一点遗憾就是图形化界面没有做出来,在查阅了资料后尝试过写界面,不过做出的界面无法实现所需要的功能,于是决定不做这个功能,我对此也感到很遗憾,相信下一次一定会完成所需要的功能。驾驶员认真负责,为了完成这次任务付出了很多,我真的由衷的感谢他·。
    最后这次让我明白了一个人走的更快,一群人走的更远,个人编程和结对编程就像如此,个人的项目虽然完成很快,但是两个人做的项目更加完善。
posted @ 2019-05-06 22:23  wangwenbo666  阅读(178)  评论(0编辑  收藏  举报