| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
一：题目要求
(1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
(2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
(3). 将代码上传至个人GitHub系统中，并将代码地址交给对方；
(4). 对同伴的作品进行代码复审，并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容将检查内容填入一下代码审查表中；
(5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub代码地址；
(6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
二：代码要求
制作一个在线教学系统，通过控制台录入，学生信息要保存到文件，有如下功能：
1：增加学生信息
2：删除学生信息
3：修改学生信息
4：根据学号查看学生信息
5：查看成绩排行榜
6：查看整体成绩分布
7：退出系统
注意要做出类似的菜单，用户输入编号后进入对应的系统功能子菜单，子菜单结构自己设计。
三：结对编程
结对伙伴：张之钰
代码题目：在线教学系统
参考文章：Java代码审查表
Java代码审查表
| 序号 | 重要性 | 激活 | 级别 | 检查项 | 结论 |
|---|---|---|---|---|---|
| 0 | 总计 | ||||
| 1 | 命名 | ||||
| 2 | 重要 | 20 | 命名规则是否与所采用的规范保持一致？ | 是 | |
| 3 | 不重要 | 20 | 是否遵循了最小长度最多信息原则？ | 否 | |
| 4 | 重要 | 50 | has/can/is前缀的函数是否返回布尔型？ | 是 | |
| 5 | 重要 | 10 | 注释是否较清晰且必要？ | 是 | |
| 6 | 重要 | Y | 10 | 复杂的分支流程是否已经被注释？ | 是 |
| 7 | 不重要 | 10 | 距离较远的}是否已经被注释？ | 否 | |
| 8 | 不重要 | 10 | 非通用变量是否全部被注释？ | 否 | |
| 9 | 重要 | Y | 50 | 函数是否已经有文档注释？（功能、输入、返回及其他可选） | 是 |
| 10 | 不重要 | 10 | 特殊用法是否被注释？ | 否 | |
| 11 | 不重要 | 20 | 每行是否只声明了一个变量？（特别是那些可能出错的类型） | 是 | |
| 12 | 重要 | 40 | 变量是否已经在定义的同时初始化？ | 是 | |
| 13 | 重要 | 40 | 类属性是否都执行了初始化？ | 是 | |
| 14 | 不重要 | 20 | 代码段落是否被合适地以空行分隔？ | 是 | |
| 15 | 不重要 | Y | 20 | 是否合理地使用了空格使程序更清晰？ | 是 |
| 16 | 不重要 | 20 | 代码行长度是否在要求之内？ | 是 | |
| 17 | 不重要 | 20 | 折行是否恰当？ | 是 | |
| 18 | 不重要 | 20 | 包含复合语句的{}是否成对出现并符合规范？ | 是 | |
| 19 | 不重要 | 20 | 是否给单个的循环、条件语句也加了{}？ | 是 | |
| 20 | 不重要 | 20 | if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？ | 是 | |
| 21 | 不重要 | 40 | 单个变量是否只做单个用途？ | 否 | |
| 22 | 重要 | 20 | 单行是否只有单个功能？（不要使用；进行多行合并） | 是 | |
| 23 | 重要 | 40 | 单个函数是否执行了单个功能并与其命名相符？ | 是 | |
| 24 | 不重要 | Y | 20 | 操作符＋＋和— —操作符的应用是否复合规范？ | 是 |
| 25 | 重要 | 20 | 单个函数不超过规定行数？ | 否 | |
| 26 | 重要 | 100 | 缩进层数是否不超过规定？ | 是 | |
| 27 | 重要 | 100 | 是否已经消除了所有警告？ | 是 | |
| 28 | 重要 | Y | 40 | 常数变量是否声明为final？ | 否 |
| 29 | 重要 | 80 | 对象使用前是否进行了检查？ | 是 | |
| 30 | 重要 | 80 | 局部对象变量使用后是否被复位为NULL？ | 是 | |
| 31 | 重要 | 70 | 对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。 | 是 | |
| 32 | 重要 | 20 | 是否确认没有同名变量局部重复定义问题? | 是 | |
| 33 | 不重要 | 20 | 程序中是否只使用了简单的表达式？ | 是 | |
| 34 | 重要 | Y | 20 | 是否已经用（）使操作符优先级明确化？ | 是 |
| 35 | 重要 | Y | 20 | 所有判断是否都使用了（常量==变量）的形式？ | 是 |
| 36 | 不重要 | 80 | 是否消除了流程悬挂？ | 是 | |
| 37 | 重要 | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集？ | 是 | |
| 38 | 重要 | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集？ | 是 | |
| 39 | 不重要 | 80 | for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX） | 是 | |
| 40 | 重要 | 80 | XML标记书写是否完整，字符串的拼写是否正确? | 是 | |
| 41 | 不重要 | 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | 否 | |
| 42 | 不重要 | 20 | 退出代码段时是否对临时对象做了释放处理? | 否 | |
| 43 | 重要 | 40 | 对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断） | 是 | |
| 44 | 重要 | Y | 60 | 入口对象是否都被进行了判断不为空？ | 否 |
| 45 | 重要 | Y | 60 | 入口数据的合法范围是否都被进行了判断？(尤其是数组) | 是 |
| 46 | 重要 | Y | 20 | 是否对有异常抛出的方法都执行了try...catch保护？ | 是 |
| 47 | 重要 | Y | 80 | 是否函数的所有分支都有返回值？ | 是 |
| 48 | 重要 | 50 | int的返回值是否合理？（负值为失败，非负值成功） | 是 | |
| 49 | 不重要 | 20 | 对于反复进行了int返回值判断是否定义了函数来处理？ | 否 | |
| 50 | 不重要 | 60 | 关键代码是否做了捕获异常处理? | 否 | |
| 51 | 重要 | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? | 是 | |
| 52 | 重要 | 60 | 是否对方法返回值对象做了null检查，该返回值定义时是否被初始化? | 是 | |
| 53 | 重要 | 60 | 是否对同步对象的遍历访问做了代码同步? | 否 | |
| 54 | 重要 | 80 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？ | 是 | |
| 55 | 重要 | 60 | 线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出? | 是 | |
| 56 | 不重要 | 20 | 原子操作代码异常中断，使用的相关外部变量是否恢复先前状态? | 否 | |
| 57 | 重要 | 100 | 函数对错误的处理是恰当的？ | 是 | |
| 58 | 重要 | 100 | 实现代码中是否消除了直接常量？（用于计数起点的简单常数例外） | 是 | |
| 59 | 不重要 | 20 | 是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )） | 是 | |
| 60 | 不重要 | 20 | 是否每个return前都要有日志记录? | 否 | |
| 61 | 不重要 | 20 | 是否有冗余判断语句？（如：if (b) return true; else return false;） | 否 | |
| 62 | 不重要 | 20 | 是否把方法中的重复代码抽象成私有函数? | 否 |
三：评价
本次的作业审查的代码是在线教学系统。
代码的优缺点并存，但整体上有点要远大于缺点，因为缺点对于整个代码的基本运行和测试都没有太大问题。
优点：
1.代码整体比较完善，要求的功能都已经实现，代码量超出了作业要求，说明编程能力很强。
2.代码从整体看上去比较整齐，可以是阅读作者很舒服的阅读，每一个功能的实现都会在开头添加一个注释。
3.代码的编码比较规范，变量名的命名也比较规范，让阅读者可以知道是什么，并不是那种汉语拼音。
4.代码书写规整，“{”和“}”的运用使得代码的可读性更高，使代码层次清晰，方便阅读。
5.代码的注释写的非常好，通过注释可以详细的了解代码的每一步都干了什么。
缺点：
1.在对对象的使用前没有做相应的判断
2.对于异常的处理不到位
3.其中有一个数组的命名不规范
总结：
通过这次的代码互审评价，我对自己也有了一个新的认识，在编写代码的时候还是有很多不规范的地方存在，也从互审的过程中学到了队友的优点，通过这种学习可以弥补自己在细节处理上的不足，从而使自己的代码质量上一个档次。也明白了结对编程对于程序员的好处，在编写代码的过程中发现自己的不足，学习别人的优点。