软件工程-第一次结对编程
1.代码地址
2.代码审查表
重要性 | 激活 | 级别 | 检查项 |
Y | 20 | 命名规则是否与所采用的规范保持一致? | |
注释 | |||
重要 | Y | 10 | 注释是否较清晰且必要? |
重要 | N | 10 | 复杂的分支流程是否已经被注释? |
N | 10 | 距离较远的}是否已经被注释? | |
N | 10 | 非通用变量是否全部被注释? | |
N | 50 | 函数是否已经有文档注释?(功能、输入、返回及其他可选) | |
重要 | Y | 10 | 特殊用法是否被注释? |
声明、空白、缩进 | |||
Y | 20 | 每行是否只声明了一个变量?(特别是那些可能出错的类型) | |
重要 | Y | 40 | 变量是否已经在定义的同时初始化? |
重要 | Y | 40 | 类属性是否都执行了初始化? |
Y | 20 | 代码段落是否被合适地以空行分隔? | |
N | 20 | 是否合理地使用了空格使程序更清晰? | |
Y | 20 | 代码行长度是否在要求之内? | |
Y | 20 | 折行是否恰当? | |
语句/功能分布/规模 | |||
Y | 20 | 包含复合语句的{}是否成对出现并符合规范? | |
N | 20 | 是否给单个的循环、条件语句也加了{}? | |
Y | 20 | if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范? | |
Y | 40 | 单个变量是否只做单个用途? | |
重要 | Y | 20 | 单行是否只有单个功能?(不要使用;进行多行合并) |
重要 | Y | 40 | 单个函数是否执行了单个功能并与其命名相符? |
Y | 20 | 操作符++和— —操作符的应用是否复合规范? | |
规模 | |||
重要 | Y | 20 | 单个函数不超过规定行数? |
重要 | Y | 100 | 缩进层数是否不超过规定? |
重要 | N | 100 | 是否已经消除了所有警告? |
重要 | Y | 40 | 常数变量是否声明为final? |
重要 | Y | 80 | 对象使用前是否进行了检查? |
重要 | N | 80 | 局部对象变量使用后是否被复位为NULL? |
重要 | Y | 70 | 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。 |
重要 | Y | 20 | 是否确认没有同名变量局部重复定义问题? |
Y | 20 | 程序中是否只使用了简单的表达式? | |
重要 | Y | 20 | 所有判断是否都使用了(常量==变量)的形式? |
重要 | N | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集? |
重要 | N | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集? |
Y | 80 | for循环是否都使用了包含下限不包含上限的形式?(k=0; k | |
重要 | Y | 40 | XML标记书写是否完整,字符串的拼写是否正确? |
N | 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | |
N | 20 | 退出代码段时是否对临时对象做了释放处理? | |
可靠性(函数) | |||
重要 | N | 60 | 入口对象是否都被进行了判断不为空? |
重要 | N | 60 | 入口数据的合法范围是否都被进行了判断?(尤其是数组) |
重要 | N | 20 | 是否对有异常抛出的方法都执行了try...catch保护? |
重要 | Y | 80 | 是否函数的所有分支都有返回值? |
重要 | N | 50 | int的返回值是否合理?(负值为失败,非负值成功) |
N | 20 | 对于反复进行了int返回值判断是否定义了函数来处理? | |
Y | 60 | 关键代码是否做了捕获异常处理? | |
重要 | N | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? |
重要 | N | 60 | 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化? |
重要 | N | 60 | 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出? |
N | 20 | 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? | |
重要 | N | 100 | 函数对错误的处理是恰当的? |
可维护性 | |||
重要 | Y | 100 | 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外) |
Y | 20 | 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) | |
N | 20 | 是否每个return前都要有日志记录? | |
N | 20 | 是否有冗余判断语句?(如:if (b) return true; else return false;) | |
Y | 20 | 是否把方法中的重复代码抽象成私有函数? |
3.代码评价
王肖男同学编写的程序题目为通过栈和队列实现停车场管理。在用户交互方面,有明确清晰的提示,在基本的数据结构--栈和队列的实现与应用方面能够熟练掌握,灵活运用,各个模块基本符合低耦合,高聚合的要求,代码简洁,逻辑清晰,功能完善。但是存在一些缺陷,主要集中于与实际应用相距甚远。一.车库的容量无法通过用户自己指定,只能通过修改代码来实现,可移植性较弱。二.缺少对计费标准的明确指定,如,不满一小时时的收费标准。三.无法展示当前车库中的车辆信息,无法查询车辆是否在车库中。四.对于栈中存储的信息未进行及时的清除,在车辆驶出车库后,应将对应的栈的节点中存储的车辆信息及时清除,以防数据泄露。通过结对编程,我了解到同学在编程时只专注于功能的实现,不能够把我具体细节。在以后的学习实践中,我也将注意这些问题,与同学进行及时有效的经验交流。