目录管理系统-代码走查记录

目录管理系统-代码走查修订记录版本号作者日期修订说明V1.0代码走查记录评审日期：2018年12月10日评审对象项目目录管理系统作者李奇评审人评审工作量一人每日序号检查项评审意见走查前准备1根据业内标准和经验，作为代码走查的参考已具备2代码都已提交，版本统一已具备程序结构组织1所有代码的结构清晰，具有良好的结构外观和整齐合格2所有的模块（函数和外部接口）定义清晰，模块分解清楚合格3所有的功能需求都明显的覆盖合格4整个代码体系结构组合合理

,分层清晰，代码之间功能划分明确合格5所有的接口模块化，尽量减少接口之间的耦合度，修改时尽量不影响其他代码模块合格6代码体系构架对空间和速度都已经进行考虑合格7数据库操作、IO操作等是否正确关闭资源。并且必须在try-catch-finally的finally中关闭。合格8一个业务如果进行多次数据库更新、添加、删除是否正确添加事务。合格9进行逻辑与、逻辑或判断时是否使用短路与、短路或。合格10多处使用相同代码时，应定义唯一方法或变量以供使用。合格11对象是否使用工厂获取。合格12导入类时，如果仅使用包中的几个类，应导入具体类，而不是导入整个包。合格13数组声明的时候使用int[]index，而不要使用intindex[]。合格14代码实现的逻辑是否与详细设计描述的逻辑一致合格15检查类中是否有无效的代码或者是无用的代码。不合格16不要使用System.out.print()以及System.err输出，需要进行日志处理不合格17所有的文件名符合文件命名规范，见名知意合格18文件和模块分组清晰合格19较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读合格20每个程序文件都小于2000行不合格代码组织1数据库查询语句不要出现select*不合格2对需要处理的字符串定义为StringBuffer，常量定义成静态的。合格3所有的变量名都小于32字符合格4有返回值的方法是否正确返回。Return语句应定义在方法结尾处。合格5代码排版是否规范。合格6所有的行每行最多只有一句代码或一个表达式合格7复杂的表达式具备可读性，添加注释说明，表达式结构清晰合格8续行缩进合格9括号在合适的位置合格10每个顺序的小块用空行隔开不合格11注释和代码对齐或接续在代码之后合格12HTML写的js方法必须要有注释。代码是否可读。不合格13代码的逻辑是否有问题。合格14HTML页面要注意排版、必要的注释、尽量减少使用alert()，JS和CSS除非必要就放到外部的单独文件中，在HTML中引用。合格15实例变量是否使用private修饰并定义getter、setter方法。合格16连接数据库的方法必须调用公用的方法。合格17异常要统一处理，异常处理方法是否符合项目组的约定合格18在Controller中不要过多的逻辑处理代码合格19不要出现魔鬼数字合格20检查可能出现空指针异常的地方，例如一个对象可能为空，却调用它的方法或属性。合格21显示的文本无拼写和语法错误合格22所有的表达式使用了正确的操作符合格函数组织1所有的函数名都小于64个字符合格2函数高内聚尽量只做一件事情，并做好合格3函数和其他代码松耦合合格4所有的参数都被使用合格5如果一个函数有返回值，在所有的出口都有返回值合格6函数使用了最少数目的return语句合格7函数的参数个数小于7个合格8使用的算法说明清楚合格9函数检查了输入数据的合法性合格10函数异常处理清楚合格11函数设计尽量考虑将来的变化合格12调试信息存在于代码中并容易激活合格13递归定义了出口合格14递归局限于一个函数合格15对接口的调用必须要有判断传入的参数不能为空和传入的参数正确。合格数据类型与变量1数据类型存在数据类型解释合格2代码避免了重新定义预先定义的数据类型合格3每一个变量都初始化了合格4所有的变量都有最小的活动范围合格5所有的全局变量都描述清楚，如全局变量的作用合格6所有的变量都用到了合格条件判断1If/else使用正确合格2判断的次数降到最小合格3Boolean表达式表示清楚合格4最常用的情况最先判断

，所有的情况都考虑合格5判断体足够短，以使得一次可以看清楚

，不要有臃肿的逻辑判断。合格6嵌套层次小于3次合格7判断条件使用引用时，应先判断其是否为null。合格循环1不要出现三层以上的for循环。如有必要必须写清楚注释合格2循环体不为空，循环体能够一次看清楚合格3循环之前做好初始化代码合格4当有明确的多次循环操作，使用For循环合格5当有不明确的多次循环操作，while循环被使用合格6代码中不存在无穷次循环合格7循环的头部进行循环控制合格8循环体内的循环变量起到指示作用。合格9所有的循环边界是否正确；合格10循环终止的条件清晰合格11循环条件、判断条件的边界值，数组、集合下标是否越界。合格注释1类、方法、判断条件、循环、主要变量是否添加注释。不合格2类名、方法名、变量名的命名是否规范。合格3有返回值的方法是否正确返回。Return语句应定义在方法结尾处。合格4源代码能够自我解释

，每个人看到代码就能很快理解合格5解释不过于简单，解释说明代码功能，准确描述代码意义合格6所有的假设和限制进行注解合格7长的控制体结束，进行注解合格8对if和for、while等要进行必要的注释，并且方法体都要用{}包起来合格9代码的注释不能过于简单,要清晰明了。合格10缺陷修改阶段，提交代码的时候必须写清楚修改的功能点和为什么要修改。合格总括1无用的代码、注解已经删除不合格2除非必要，不要在循环体内定义对象。合格其他注意项1尽量减少同名的类（如java.sql.Date，java.util.Date）合格2不要在循环中反复定义创建变量for()｛Stringstr=（newString）v.next()；｝合格3可能重复执行的SQl语句尽量使用preparedStatment合格4浮点型要精确比较时不要使用＝＝，而如下进行Math.abs(x-0.0)<Double.MIN.value