软件工程结对作业1
| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业目标 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个”高质量“软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
结对伙伴
计科1704 冯宝陆
GitHub代码地址
https://github.com/Excting/Homework/blob/master/Bank.java
代码审查表
| 序号 | 重要性 | 审查项 | 结论 |
|---|---|---|---|
| 命名 | |||
| 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 | 不重要 | 是否把方法中的重复代码抽象成私有函数? | 否 |
代码评论
优点
1、程序的结构非常严谨，模块化的设计思想贯穿于整个程序设计中，基本上每个功能实现都有对应的功能子函数，易于分析。
2、函数命名规范，足以说明该函数的作用，增强了代码的可读性
3、对于程序的排版、格式非常地合理，循环层次分明，变量名和函数名的定义很准确，便于阅读；
4、代码整体布局美观，书写工整，缩进及断行很有规律
6、代码中的类运用得非常灵活，思维逻辑清晰明了。
7、书写规范，没有在同一行中出现两个或两个以上的功能语句
缺点：
1、程序中对代码的注释过少，降低了代码的可读性
2、程序中运用了大量的类，有几处在申请了内存后并没有及时的释放，导致大量占用内存资源。
总结
通过阅读审核同学的代码，结合代码审查表，让我注意到了许多以前不曾注意的小细节，让我对代码规范更加重视，明白了我们学习的目的并不是为了写代码而写代码，以前对于代码的注释很随意，经过这次作业，体会到了注释对于别人读懂自己的代码来说有多么重要。
