1. 待审查项目
2. Java代码审查表
重要性 |
激活 |
级别 |
检查项 |
总计 |
|
|
|
命名 |
|
|
|
重要 |
N |
20 |
命名规则是否与所采用的规范保持一致? |
|
Y |
20 |
是否遵循了最小长度最多信息原则? |
重要 |
|
50 |
has/can/is前缀的函数是否返回布尔型? |
注释 |
|
|
|
重要 |
N |
10 |
注释是否较清晰且必要? |
重要 |
N |
10 |
复杂的分支流程是否已经被注释? |
|
N |
10 |
距离较远的}是否已经被注释? |
|
N |
10 |
非通用变量是否全部被注释? |
重要 |
N |
50 |
函数是否已经有文档注释?(功能、输入、返回及其他可选) |
|
|
10 |
特殊用法是否被注释? |
声明、空白、缩进 |
|
|
|
|
Y |
20 |
每行是否只声明了一个变量?(特别是那些可能出错的类型) |
重要 |
N |
40 |
变量是否已经在定义的同时初始化? |
重要 |
Y |
40 |
类属性是否都执行了初始化? |
|
Y |
20 |
代码段落是否被合适地以空行分隔? |
|
N |
20 |
是否合理地使用了空格使程序更清晰? |
|
Y |
20 |
代码行长度是否在要求之内? |
|
Y |
20 |
折行是否恰当? |
语句/功能分布/规模 |
|
|
|
|
Y |
20 |
包含复合语句的{}是否成对出现并符合规范? |
|
|
20 |
是否给单个的循环、条件语句也加了{}? |
|
Y |
20 |
if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范? |
|
Y |
40 |
单个变量是否只做单个用途? |
重要 |
N |
20 |
单行是否只有单个功能?(不要使用;进行多行合并) |
重要 |
Y |
40 |
单个函数是否执行了单个功能并与其命名相符? |
|
Y |
20 |
操作符++和— —操作符的应用是否复合规范? |
规模 |
|
|
|
重要 |
Y |
20 |
单个函数不超过规定行数? |
重要 |
Y |
100 |
缩进层数是否不超过规定? |
重要 |
N |
100 |
是否已经消除了所有警告? |
重要 |
|
40 |
常数变量是否声明为final? |
重要 |
Y |
80 |
对象使用前是否进行了检查? |
重要 |
N |
80 |
局部对象变量使用后是否被复位为NULL? |
重要 |
|
70 |
对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1]) |
重要 |
Y |
20 |
是否确认没有同名变量局部重复定义问题? |
|
Y |
20 |
程序中是否只使用了简单的表达式? |
重要 |
|
20 |
是否已经用()使操作符优先级明确化? |
重要 |
Y |
20 |
所有判断是否都使用了(常量==变量)的形式? |
|
|
80 |
是否消除了流程悬挂? |
重要 |
|
80 |
是否每个if-else if-else语句都有最后一个else以确保处理了全集? |
重要 |
|
80 |
是否每个switch-case语句都有最后一个default以确保处理了全集? |
|
Y |
80 |
for循环是否都使用了包含下限不包含上限的形式?(k=0; k
|
重要 |
Y |
40 |
XML标记书写是否完整,字符串的拼写是否正确? |
|
|
40 |
对于流操作代码的异常捕获是否有finally操作以关闭流对象? |
|
N |
20 |
退出代码段时是否对临时对象做了释放处理? |
重要 |
|
40 |
对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断) |
可靠性(函数) |
|
|
|
重要 |
Y |
60 |
入口对象是否都被进行了判断不为空? |
重要 |
Y |
60 |
入口数据的合法范围是否都被进行了判断?(尤其是数组) |
重要 |
Y |
20 |
是否对有异常抛出的方法都执行了try...catch保护? |
重要 |
Y |
80 |
是否函数的所有分支都有返回值? |
重要 |
Y |
50 |
int的返回值是否合理?(负值为失败,非负值成功) |
|
|
20 |
对于反复进行了int返回值判断是否定义了函数来处理? |
|
Y |
60 |
关键代码是否做了捕获异常处理? |
重要 |
|
60 |
是否确保函数返回CORBA对象的任何一个属性都不能为null? |
重要 |
|
60 |
是否对方法返回值对象做了null检查,该返回值定义时是否被初始化? |
重要 |
|
60 |
是否对同步对象的遍历访问做了代码同步? |
重要 |
|
80 |
是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作? |
重要 |
|
60 |
线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出? |
|
|
20 |
原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? |
重要 |
Y |
100 |
函数对错误的处理是恰当的? |
可维护性 |
|
|
|
重要 |
Y |
100 |
实现代码中是否消除了直接常量?(用于计数起点的简单常数例外) |
|
Y |
20 |
是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) |
|
N |
20 |
是否每个return前都要有日志记录? |
|
N |
20 |
是否有冗余判断语句?(如:if (b) return true; else return false;) |
|
N |
20 |
是否把方法中的重复代码抽象成私有函数? |
3. 代码点评
该代码实现了“消息轰炸机”这一趣味程序,构思精巧,使用有趣(第二次执行的时候因为操作失误把自己电脑崩了),总体设计和算法结构都十分出色,对我日后的的Java程序开发提供了很大帮助。
程序的优缺点都十分明显。首先程序的设计构思是十分出彩的,在实现目标功能后,还在其中设置了隐藏彩蛋,进一步增强了趣味性,提升用户使用体验;在功能界面上,程序设计了独立的用户界面窗口,设计美观,引导信息清晰,大大提升了程序的可用性和美观性,这点也恰是我的不足;在代码编写方面,也基本符合大部分规范。而程序的缺点主要在于以下几点:首先,也是最重要的是,通篇代码几乎没有任何注释,唯独的几条单行注释也是语焉不详,导致阅读性极差;其次,部分代码中没有合理的使用空格和换行符,出现了运算符没有与变量分隔开、两条语句出现在一行等问题,进一步降低了代码的可读性;最后则是类成员变量并未封装,没有形成良好的面向对象编程习惯。
总的来说,程序总体设计完善,界面清晰美观,独立性好,可用性强,但代码的可读性差,不利于后续开发和维护,建议重新整理代码格式,添加注释,否则可能会影响后续开发成员的开发体验(别太用户至上啦 也要考虑考虑你可怜小伙伴嘛)。