代码审查
结队编程伙伴:
本次审查的代码:代码审查检查表
重要性 | 激活 | 级别 | 检查项 |
---|---|---|---|
总计 | |||
命名 | |||
重要 | Y | 20 | 命名规则是否与所采用的规范保持一致? |
Y | 20 | 是否遵循了最小长度最多信息原则? | |
重要 | Y | 50 | has/can/is前缀的函数是否返回布尔型? |
注释 | |||
重要 | Y | 10 | 注释是否较清晰且必要? |
重要 | Y | 10 | 复杂的分支流程是否已经被注释? |
N | 10 | 距离较远的}是否已经被注释? | |
N | 10 | 非通用变量是否全部被注释? | |
重要 | N | 50 | 函数是否已经有文档注释?(功能、输入、返回及其他可选) |
Y | 10 | 特殊用法是否被注释? | |
声明、空白、缩进 | |||
N | 20 | 每行是否只声明了一个变量?(特别是那些可能出错的类型) | |
重要 | N | 40 | 变量是否已经在定义的同时初始化? |
重要 | Y | 40 | 类属性是否都执行了初始化? |
Y | 20 | 代码段落是否被合适地以空行分隔? | |
Y | 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 | 缩进层数是否不超过规定? |
重要 | Y | 100 | 是否已经消除了所有警告? |
重要 | N | 40 | 常数变量是否声明为final? |
重要 | Y | 80 | 对象使用前是否进行了检查? |
重要 | N | 80 | 局部对象变量使用后是否被复位为NULL? |
重要 | Y | 70 | 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。 |
重要 | Y | 20 | 是否确认没有同名变量局部重复定义问题? |
Y | 20 | 程序中是否只使用了简单的表达式? | |
重要 | Y | 20 | 是否已经用()使操作符优先级明确化? |
重要 | Y | 20 | 所有判断是否都使用了(常量==变量)的形式? |
Y | 80 | 是否消除了流程悬挂? | |
重要 | Y | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集? |
重要 | Y | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集? |
80 | for循环是否都使用了包含下限不包含上限的形式?(k=0; k<MAX) | ||
重要 | Y | 40 | XML标记书写是否完整,字符串的拼写是否正确? |
N | 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | |
N | 20 | 退出代码段时是否对临时对象做了释放处理? | |
重要 | Y | 40 | 对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断) |
可靠性(函数) | |||
重要 | Y | 60 | 入口对象是否都被进行了判断不为空? |
重要 | Y | 60 | 入口数据的合法范围是否都被进行了判断?(尤其是数组) |
重要 | Y | 20 | 是否对有异常抛出的方法都执行了try...catch保护? |
重要 | Y | 80 | 是否函数的所有分支都有返回值? |
重要 | Y | 50 | int的返回值是否合理?(负值为失败,非负值成功) |
Y | 20 | 对于反复进行了int返回值判断是否定义了函数来处理? | |
Y | 60 | 关键代码是否做了捕获异常处理? | |
重要 | N | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? |
重要 | N | 60 | 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化? |
重要 | Y | 60 | 是否对同步对象的遍历访问做了代码同步? |
重要 | Y | 80 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作? |
重要 | Y | 60 | 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出? |
Y | 20 | 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? | |
重要 | Y | 100 | 函数对错误的处理是恰当的? |
可维护性 | |||
重要 | N | 100 | 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外) |
Y | 20 | 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) | |
N | 20 | 是否每个return前都要有日志记录? | |
N | 20 | 是否有冗余判断语句?(如:if (b) return true; else return false;) | |
Y | 20 | 是否把方法中的重复代码抽象成私有函数? |
评价
拿到同伴的代码后,大略看了一下,然后就为之折服了,好整洁的代码,缩进也好,代码块的分隔也好,都做的很好。女生写的代码看起来就是和人一样整洁啊!!在这里不禁反思了一下自己,默默地翻了翻自己的代码,要注释的没注释,对齐随缘,变量申明都挤在一起,判断条件太长也不分解,单个循环也不加大括号……自己在写代码时只考虑了功能的实现,没有考虑代码的可读性,关注代码的逻辑性而忘却了代码的规范性与代码的艺术!我的代码外面看起来就没有什么艺术,谁愿意难为自己去看它里面的艺术[笑哭]。回到小伙伴的代码上来,这真的是写的很好的一篇作品,其实现了在窗口中模拟出一个时钟的功能,分钟每走1圈,时针则走1/60圈。而且通过颜色的运用,整个效果看起来也很不错。在程序中,使用了两个线程实现对两个指针的绘画,并且对线程中的sleep()进行了异常捕捉处理,而且两个线程用的不同的方法实现的,看这个主要类的类名为Lab3_3,应该是某次实验课要求的程序设计。
另外,就是些许不足之处了:
1.比如在计算指针末端坐标x、y时,逻辑表达式有点长,x1=(int) (60*Math.sin(0-(a+30)*Math.PI/30))+200;y1=(int) (60*Math.cos(0-(a+30)*Math.PI/30))+200;
如果这里把它分解了并加以注释会更友好些。
2.在程序中的只包含一条语句的if句型中,if(a%2==0) g.drawOval(x, y, 2, 2);
没有加大括号将逻辑执行语句包裹,而是将它跟在if后面。
3.然后就是异常捕捉,虽然在这段程序中不影响,而且好像finally中也没什么好写的,但最好加上finally。try { Thread.sleep(1000);} catch (InterruptedException e) { e.printStackTrace();}
总之,很好的代码,伙伴的实力也很强,思维很严谨,注意一下细枝末节的东西就好了,点个赞。
小结
通过对同伴的代码复审,了解到这是个思维严谨,代码风格很不错的伙伴,同时也了解到了写代码不仅要考虑实现,也要考虑代码的风格与规范,以及很多以前不注意的东西。要当一个合格的优雅的程序员还任重道远,需要不断的磨炼啊。