您好,欢迎访问三七文档
JAVA代码检查表北京东和盛达科技有限公司北京东和盛达科技有限公司模块名称:版本号:检查时间:检查员:序号检查项检查结果(Y/N/NA)问题描述1.命名、注释及风格1.1文件、类/接口、静态变量、成员变量、方法及关键代码是否都有格式良好、简明扼要、的注释?注释是否是对设计思路的说明而不仅仅是代码行为的描述?是否存在过时的注释或废代码注释?1.2文件中各种段落布局是否合理、是否用恰当的空行分隔?代码的断行、对齐、缩进、空行是否恰当?1.3代码中的变量、属性、参数、方法、类是否恰当命名?有无易相互混淆的命名?1.4其他编码风格是否符合规范要求?如if、else永远加{};for、while的格式;switch永远有default;case有break等等2.设计原则2.1成员变量和方法public/private/protected关键字是否恰当?内部类、非公共类及其内部成员、方法的访问权限是否合适?2.2嵌套内部类是否超过2层?2.3没有使用任何实例类成员(包括方法和成员变量)的方法是否被声明为静态的?2.4异常发生时,记录错误日志是否存在使用System.out.println而不是日志模块记录日志的情况发生?2.5参数、变量等的类型是否定义的合适?精度是否足够?方法的返回值是否定义恰当?2.6使用已有设计模式时,该模式要求的技术细节是否实现正确、完整?2.7是否存在废代码?是否存在没有使用的参数、变量、对象实例?是否存在重复、无效的方法、语句或子条件表达式?子类或数据处理下游代码中是否重复设计了父类或数据处理上游代码中已有的功能?3.缺陷检查3.1程序逻辑是否符合详细设计?3.2输入参数、调用其他函数的返回值是否有必要校验合法性、完整性、依赖关系?如有必要,是否做了恰当的校验?如无必要,是否有多余的代码?序号检查项检查结果(Y/N/NA)问题描述3.3是否避免了直接抛出Exception类异常,而没有抛出恰当的由Exception派生的异常类?3.4trycatch的结构是否合理?catch语句处理是否恰当?异常转抛时是否携带了嵌套异常?3.5打开的流、连接等资源是否在finally语句块或恰当的地方关闭或释放了?临时资源使用完后是否及时释放了?如临时文件要及时删除。各种资源释放的顺序是否正确?3.6条件、循环中的判断边界值是否恰当?3.7程序块的break、return、throw是否恰当?3.8相似的代码块是否是拷贝过来的?如果是,则需检查拷贝的代码中每处需要修改的地方是否都修改了。3.9是否存在其他可能造成缺陷的代码?在if条件中赋值精度丢失浮点数判等循环体中修改循环变量字符串比较没有使用equals或compareTo不恰当的static变量4.代码优化4.1在不影响可读性和易维护性的前提下,对象是否可重复利用?如StringBuffer可以通过setLength(0)重复利用,无需每次重复创建新实例。4.2是否有这样的代码:newString(””)?4.3嵌套的条件判断、循环是否可优化?嵌套的条件判断、循环是否可替换为较简单的结构?是否存在可以合并的循环或条件判断?循环体内是否存在可以提到循环体外的代码?如实例化对象或声明变量等4.4循环条件中或重复出现的如.length().size().getClass().getName()等取值方法的返回值是否使用了临时变量代替?4.5频繁拼装字符串时,是否使用了StringBuffer,并事先分配恰当空间?5.目录结构5.1Jsp,Action,service,dao,逻辑分层是否明确序号检查项检查结果(Y/N/NA)问题描述5.2配置文件(struts,spring,sql)是否条理清晰,目录规范5.3页面资源文件(JavaScript,CSS,images)目录是否规范
本文标题:代码检查表
链接地址:https://www.777doc.com/doc-5009477 .html