代码审查
结队编程伙伴：翁超
本次审查代码：https://git.coding.net/xiangshangbasha/disicizuoye.git
java代码审查检查表
|
重要性 |
激活 |
级别 |
检查项 |
|
总计 |
|||
|
命名 |
|||
|
重要 |
Y |
20 |
命名规则是否与所采用的规范保持一致？ |
| Y |
20 |
是否遵循了最小长度最多信息原则？ |
|
|
重要 |
Y |
50 |
has/can/is前缀的函数是否返回布尔型？ |
|
注释 |
|||
|
重要 |
Y |
10 |
注释是否较清晰且必要？ |
|
重要 |
Y |
10 |
复杂的分支流程是否已经被注释？ |
| N |
10 |
距离较远的}是否已经被注释？ |
|
| N |
10 |
非通用变量是否全部被注释？ |
|
|
重要 |
Y |
50 |
函数是否已经有文档注释？（功能、输入、返回及其他可选） |
| N |
10 |
特殊用法是否被注释？ |
|
|
声明、空白、缩进 |
|||
| Y |
20 |
每行是否只声明了一个变量？（特别是那些可能出错的类型） |
|
|
重要 |
N |
40 |
变量是否已经在定义的同时初始化？ |
|
重要 |
Y |
40 |
类属性是否都执行了初始化？ |
| N |
20 |
代码段落是否被合适地以空行分隔？ |
|
|
Y |
20 |
是否合理地使用了空格使程序更清晰？ |
|
| Y |
20 |
代码行长度是否在要求之内？ |
|
| Y |
20 |
折行是否恰当？ |
|
|
语句/功能分布/规模 |
|||
| Y |
20 |
包含复合语句的{}是否成对出现并符合规范？ |
|
| Y |
20 |
是否给单个的循环、条件语句也加了{}？ |
|
| Y |
20 |
if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？ |
|
| Y |
40 |
单个变量是否只做单个用途？ |
|
|
重要 |
Y |
20 |
单行是否只有单个功能？（不要使用；进行多行合并） |
|
重要 |
N |
40 |
单个函数是否执行了单个功能并与其命名相符？ |
|
Y |
20 |
操作符＋＋和— —操作符的应用是否复合规范？ |
|
|
规模 |
|||
|
重要 |
Y |
20 |
单个函数不超过规定行数？ |
|
重要 |
Y |
100 |
缩进层数是否不超过规定？ |
|
重要 |
N |
100 |
是否已经消除了所有警告？ |
|
重要 |
Y |
40 |
常数变量是否声明为final？ |
|
重要 |
Y |
80 |
对象使用前是否进行了检查？ |
|
重要 |
N |
80 |
局部对象变量使用后是否被复位为NULL？ |
|
重要 |
Y |
70 |
对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。 |
|
重要 |
N |
20 |
是否确认没有同名变量局部重复定义问题? |
| Y |
20 |
程序中是否只使用了简单的表达式？ |
|
|
重要 |
Y |
20 |
是否已经用（）使操作符优先级明确化？ |
|
重要 |
Y |
20 |
所有判断是否都使用了（常量==变量）的形式？ |
| Y |
80 |
是否消除了流程悬挂？ |
|
|
重要 |
N |
80 |
是否每个if-else if-else语句都有最后一个else以确保处理了全集？ |
|
重要 |
Y |
80 |
是否每个switch-case语句都有最后一个default以确保处理了全集？ |
| Y |
80 |
for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX） |
|
|
重要 |
Y |
40 |
XML标记书写是否完整，字符串的拼写是否正确? |
| Y |
40 |
对于流操作代码的异常捕获是否有finally操作以关闭流对象? |
|
| Y |
20 |
退出代码段时是否对临时对象做了释放处理? |
|
|
重要 |
N |
40 |
对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断） |
|
可靠性（函数） |
|||
|
重要 |
Y |
60 |
入口对象是否都被进行了判断不为空？ |
|
重要 |
Y |
60 |
入口数据的合法范围是否都被进行了判断？(尤其是数组) |
|
重要 |
Y |
20 |
是否对有异常抛出的方法都执行了try...catch保护？ |
|
重要 |
Y |
80 |
是否函数的所有分支都有返回值？ |
|
重要 |
Y |
50 |
int的返回值是否合理？（负值为失败，非负值成功） |
| Y |
20 |
对于反复进行了int返回值判断是否定义了函数来处理？ |
|
| Y |
60 |
关键代码是否做了捕获异常处理? |
|
|
重要 |
Y |
60 |
是否确保函数返回CORBA对象的任何一个属性都不能为null? |
|
重要 |
Y |
60 |
是否对方法返回值对象做了null检查，该返回值定义时是否被初始化? |
|
重要 |
N |
60 |
是否对同步对象的遍历访问做了代码同步? |
|
重要 |
Y |
80 |
是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？ |
|
重要 |
N |
60 |
线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出? |
| Y |
20 |
原子操作代码异常中断，使用的相关外部变量是否恢复先前状态? |
|
|
重要 |
N |
100 |
函数对错误的处理是恰当的？ |
|
可维护性 |
|||
|
重要 |
Y |
100 |
实现代码中是否消除了直接常量？（用于计数起点的简单常数例外） |
| Y |
20 |
是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )） |
|
| N |
20 |
是否每个return前都要有日志记录? |
|
| Y |
20 |
是否有冗余判断语句？（如：if (b) return true; else return false;） |
|
| N |
20 |
是否把方法中的重复代码抽象成私有函数? |
评价
首先，我结队伙伴翁超在编写贪吃蛇这个先小游戏的时候用了三个类来实现其中的功能。第一个类greedySnackMain：框架类 ；第二个类snackWin: 面板类，这里主要就是对面板进行操作； 第三个类* Snack:蛇类 。总之，思想很简单：绘制完框架，新建一个线程让蛇跑起来就可以了。可以看出，他在编写这段代码时，结构、思路都是十分清晰的。但是，也存在一些小问题。1、该注释的地方没有注释。如boolean Dead() {for(int i = 1; i < lt.size(); i++) {if(lt.get(0).getX() == lt.get(i).getX() && lt.get(0).getY() == lt.get(i).getY()) return true; }return false; }这段代码，如果不加注释的话，别人压根看不懂。2、在命名方法是不太规范，如 public void ActionPerformed(ActionEvent e)。众所周知，在java中，方法的命名在第一个字母的首字母不需要大写，从第二个代词开始才大写。从他的代码中我也学到了很多东西、如编程思想，代码规范等方面。