| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10583 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 单元测试练习 |
1.结对对象及代码地址
结对对象：陈 才
代码地址：才哥出手，石破天惊
2.代码审查表
| 功能模块名称 | 在线教学系统 | ||
| 审查人 | 赵乐 | 审查日期 | 2020-4-14 |
| 代码名称 | OnlineTeachingSystem | 代码作者 | 陈才(173401010226) |
| 序号 | 重要性 | 审查项 | 结论 |
| 命名 | |||
| 1 | 重要 | 命名规则是否与所采用的规范保持一致？ | 是 |
| 2 | 重要 | 是否遵循了最小长度最多信息原则？ | 否 |
| 3 | has/can/is前缀的函数是否返回布尔型？ | 是 | |
| 注释 | |||
| 4 | 重要 | 注释是否较清晰且必要？ | 是 |
| 5 | 重要 | 复杂的分支流程是否已经被注释？ | 是 |
| 6 | 距离较远的}是否已经被注释？ | 是 | |
| 7 | 非通用变量是否全部被注释？ | 否 | |
| 8 | 重要 | 函数是否已经有文档注释？（功能、输入、返回及其他可选） | 是 |
| 9 | 特殊用法是否被注释？ | 无 | |
| 声明、空白、缩进 | |||
| 10 | 每行是否只声明了一个变量？（特别是那些可能出错的类型） | 是 | |
| 11 | 重要 | 变量是否已经在定义的同时初始化？ | 是 |
| 12 | 重要 | 类属性是否都执行了初始化？ | 否 |
| 13 | 代码段落是否被合适地以空行分隔？ | 是 | |
| 14 | 是否合理地使用了空格使程序更清晰？ | 否 | |
| 15 | 代码行长度是否在要求之内？ | 是 | |
| 16 | 折行是否恰当？ | 是 | |
| 语句/功能分布 | |||
| 17 | 包含复合语句的{}是否成对出现并符合规范？ | 是 | |
| 18 | 是否给单个的循环、条件语句也加了{}？ | 否 | |
| 19 | if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？ | 是 | |
| 20 | 单个变量是否只做单个用途？ | 是 | |
| 21 | 重要 | 单行是否只有单个功能？（不要使用；进行多行合并） | 是 |
| 22 | 重要 | 单个函数是否执行了单个功能并与其命名相符？ | 是 |
| 23 | 操作符＋＋和— —操作符的应用是否复合规范？ | 是 | |
| 规模 | |||
| 24 | 重要 | 单个函数不超过规定行数？ | 是 |
| 25 | 重要 | 缩进层数是否不超过规定？ | 否 |
| 26 | 重要 | 是否已经消除了所有警告？ | 是 |
| 27 | 重要 | 常数变量是否声明为final？ | 是 |
| 28 | 重要 | 对象使用前是否进行了检查？ | 是 |
| 29 | 重要 | 局部对象变量使用后是否被复位为NULL？ | 否 |
| 30 | 重要 | 对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。 | 是 |
| 31 | 重要 | 是否确认没有同名变量局部重复定义问题? | 是 |
| 32 | 程序中是否只使用了简单的表达式？ | 否 | |
| 33 | 重要 | 是否已经用（）使操作符优先级明确化？ | 无 |
| 34 | 重要 | 所有判断是否都使用了（常量==变量）的形式？ | 否 |
| 35 | 是否消除了流程悬挂？ | 是 | |
| 36 | 重要 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集？ | 是 |
| 37 | 重要 | 是否每个switch-case语句都有最后一个default以确保处理了全集？ | 否 |
| 38 | for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX） | 无 | |
| 39 | 重要 | XML标记书写是否完整，字符串的拼写是否正确? | 是 |
| 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | 无 | |
| 41 | 退出代码段时是否对临时对象做了释放处理? | 是 | |
| 42 | 重要 | 对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断） | 是 |
| 可靠性（函数） | |||
| 43 | 重要 | 入口对象是否都被进行了判断不为空？ | 是 |
| 44 | 重要 | 入口数据的合法范围是否都被进行了判断？(尤其是数组) | 是 |
| 45 | 重要 | 是否对有异常抛出的方法都执行了try...catch保护？ | 无 |
| 46 | 重要 | 是否函数的所有分支都有返回值？ | 否 |
| 47 | 重要 | int的返回值是否合理？（负值为失败，非负值成功） | 是 |
| 48 | 对于反复进行了int返回值判断是否定义了函数来处理？ | 是 | |
| 49 | 关键代码是否做了捕获异常处理? | 是 | |
| 50 | 重要 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? | 无 |
| 51 | 重要 | 是否对方法返回值对象做了null检查，该返回值定义时是否被初始化? | 否 |
| 52 | 重要 | 是否对同步对象的遍历访问做了代码同步? | 否 |
| 53 | 重要 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？ | 否 |
| 54 | 重要 | 线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出? | 是 |
| 55 | 原子操作代码异常中断，使用的相关外部变量是否恢复先前状态? | 是 | |
| 56 | 重要 | 函数对错误的处理是恰当的？ | 是 |
| 可维护性 | |||
| 57 | 重要 | 实现代码中是否消除了直接常量？（用于计数起点的简单常数例外） | 是 |
| 58 | 是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )） | 是 | |
| 59 | 是否每个return前都要有日志记录? | 无 | |
| 60 | 是否有冗余判断语句？（如：if (b) return true; else return false;） | 无 | |
| 61 | 是否把方法中的重复代码抽象成私有函数? | 否 | |
3.总结
本次结对编程作业中，结对对象为同学：陈才，审查代码为他编写的‘在线教学系统’，他在编写程序中采用得是Java语言。通过对他的程序代码审查，结合相关要求进行对比，总结了以下几点优缺点：
优点：
1.程序代码比较规范，变量定义和函数区分明确，在函数命名以及整体布局上都是符合要求的；
2.注释详细且清晰易懂，无论时复杂的分支流程还是距离较远的}都添加了相关注释，便于他人理解程序；
3.在变量的声明和初始化上都时比较明确的；
4.程序的功能满足了基本实现，同时相关功能设计比较全面，考虑得情况也比较全面，错误操作时也会有异常提示；
5.有效地消除了所有的警告信息，代码能够很好地运行实现。
缺点：
1.在程序功能实现上存在一些问题，比如在输入账户密码是没有加密显示，在注册账户时也存在一些小的bug以及输入账户时没有返回上一级界面选择等；
2.代码的时间复杂度和空间复杂度都不算低，算法可进一步精简；
3.有些函数中对文件调用多次定义。
整体上，我的结对对象的‘在线教学系统’程序设计和实现上是非常好的。无论是在代码编写中，尤其是对于代码的规范；还是程序的具体实现上，在现阶段都是比较成功的。尽管存在一些小问题，不过在后续的调试中都能很好的解决，这也体现了他的调试和修改水平能力是非常不错的。