JAVA代码检查清单
说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。
重要性 总计 命名 重要 重要 注释 重要 重要 重要 声明、空白、缩进 重要 重要 激级活 别 检查项 20 命名规则是否与所采用的规范保持一致? 20 是否遵循了最小长度最多信息原则? 50 has/can/is前缀的函数是否返回布尔型? 10 注释是否较清晰且必要? Y 复杂的分支流程是否已经被注释? 10 10 距离较远的}是否已经被注释? 10 非通用变量是否全部被注释? Y 函数是否已经有文档注释?(功能、输入、返回及其他可选) 50 10 特殊用法是否被注释? 20 每行是否只声明了一个变量?(特别是那些可能出错的类型) 40 变量是否已经在定义的同时初始化? 40 类属性是否都执行了初始化? 20 代码段落是否被合适地以空行分隔? Y 是否合理地使用了空格使程序更清晰? 20 20 代码行长度是否在要求之内? 20 折行是否恰当? 语句/功能分布/规模 重要 重要 规模 重要 重要 可靠性(总则/变量和语句) 重要 重要 重要 重要 重要 重要 20 包含复合语句的{}是否成对出现并符合规范? 20 是否给单个的循环、条件语句也加了{}? if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规 20 范? 40 单个变量是否只做单个用途? 20 单行是否只有单个功能?(不要使用;进行多行合并) 40 单个函数是否执行了单个功能并与其命名相符? Y 操作符++和— —操作符的应用是否复合规范? 20 20 单个函数不超过规定行数? 100 缩进层数是否不超过规定? 100 是否已经消除了所有警告? Y 40 常数变量是否声明为final? 80 对象使用前是否进行了检查? 80 局部对象变量使用后是否被复位为NULL? 对数组的访问是否是安全的?(合法的index取值为[0, 70 MAX_SIZE-1])。 20 是否确认没有同名变量局部重复定义问题? 重要 重要 重要 20 程序中是否只使用了简单的表达式? Y Y 是否已经用()使操作符优先级明确化? 20 20 所有判断是否都使用了(常量==变量)的形式? 80 是否消除了流程悬挂? 是否每个if-else if-else语句都有最后一个else以确保处理了全 80 集? 是否每个switch-case语句都有最后一个default以确保处理了全 80 集? for循环是否都使用了包含下限不包含上限的形式?(k=0; 80 k) 40 XML标记书写是否完整,字符串的拼写是否正确?
40 对于流操作代码的异常捕获是否有finally操作以关闭流对象? 20 退出代码段时是否对临时对象做了释放处理?
40 对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断) Y Y Y Y
入口对象是否都被进行了判断不为空? 60
60 入口数据的合法范围是否都被进行了判断?(尤其是数组) 20 是否对有异常抛出的方法都执行了try...catch保护? 是否函数的所有分支都有返回值? 80
重要
重要 重要
可靠性(函数) 重要 重要 重要 重要 重要 重要 重要 重要 重要
50 int的返回值是否合理?(负值为失败,非负值成功) 20 对于反复进行了int返回值判断是否定义了函数来处理? 60 关键代码是否做了捕获异常处理?
60 是否确保函数返回CORBA对象的任何一个属性都不能为null? 是否对方法返回值对象做了null检查,该返回值定义时是否被初 60
始化? 60 是否对同步对象的遍历访问做了代码同步?
是否确认在对Map对象使用迭代遍历过程中没有做增减元素操 80
作? 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常
60
而退出? 20 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? 100 函数对错误的处理是恰当的?
实现代码中是否消除了直接常量?(用于计数起点的简单常数例 100
外) 20 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) 20 是否每个return前都要有日志记录?
20 是否有冗余判断语句?(如:if (b) return true; else return false;) 20 是否把方法中的重复代码抽象成私有函数?
重要 重要 可维护性 重要
本文来源:https://www.wddqw.com/doc/b57ffb706aeae009581b6bd97f1922791688befa.html