1.同伴代码
代码
2.代码审查
| 序号 |
重要性 |
审查项 |
结论 |
| 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.评论
小伙伴的代码是一个比较完备的学生管理系统，有添加学生信息、按学号查询学生信息、显示当前所有学生信息、查看所有学生成绩排名等管理学生信息的功能。首先从代码量上可以看出同伴的能力非常强，可以完成大量代码的编写，但是从代码审查的角度来看还是有一些不足的地方。小伙伴的代码格式比较公正，每一行的代码只有一行语句，没有给人杂乱无章的感觉，不过个别地方的语句太长，需要拉动拉条才能看到全部的语句，在代码审查时不是很方便。大量的代码没有注释，在理解代码的功能时造成了不便。虽然代码本身有中文输出，在一定程度上对阅读有一定的帮助，不过必要的注释还是必不可少的。代码中对变量和函数的定义比较准确并且使用英文来定义，这让变量和函数的意义更容易理解。在每次变量定义时能够初始化变量，在使用时不会出现错误。代码中对于各种特殊的情况考虑的也比较周全，能够用判断语句来进行特殊处理。通过这次代码审查，对我自己的能力有提高，很多审查项不是很明白，在网上百度一下才搞懂，以后写代码的时候也要注意到这些问题。
浙公网安备 33010602011771号