code review(程序员必看).ppt

Code Review 为什么要进行Code Review？? 如何做Code Review？ 如何使用工具进行Code Review？ CheckStyle FindBugs PMD 使用工具进行Code Review的局限性 我们可以做得更好 为什么要Code Review 为完成一个软件项目需要多个成员的参与，因此存在编码风格和质量上的差异。尽管在一个项目开始之初，团队内部就对编码进行了格式化上的规范，但是在实际 过程中，还是搀杂了许多个人的因素，比如习惯，思维方式等等。在整体的角度上讲，差异存在越多对项目代码的可读性及维护性影响也越大。又由于一些人可能限于水平，在编码过程当中引入了较低级且显而易见的错误，比如，资源没有释放，造成泄漏。这些隐患如果不是通过Code Review来发现和纠正，通过测试是很难发现的。随着时间的推移，积累的问题会逐渐增 多，到一定程度的话就很难再去着手处理。 Code Review可以“防患于未然”，确保质量，也能提高整个开发团队的开发水平。 如何做Code Review 统一的编程规范和设计文档规范.也会用这些作为Code Review的检查标准 ? 完整的技术架构和技术架构说明或事例，争取能够包含程序编写的各个方面 ? ? 不定期的Code Review会议及代码讲解 ? Code Review时间安排 Code Review的时间安排可以根据项目大小和周期长短来定，小项目（如3个月内）可以定在10天内一次，大项目（6个月以上）可以在半个月内一次，次数的 安排也要讲究，在项目的开始之处应该安排密一些，在项目进展到一定的程度后，周期可以更长，一个月内一次。这种安排出于以下考虑，一是项目成员对项目的 认知在开始阶段比较粗浅，问题较多，因此需要及时的纠正；而当项目成员随着进展而成长后，有很多问题可以为成员自己所避免,因此安排Code Review的次数应该减少。除了纠正错误和问题之外，Code Review可以通过相关人员的参与，来交流一些技巧和宝贵的经验，以讲解和讨论的形式获得提高。 ? 使用工具进行Code Review 自动代码复查工具 CheckStyle FindBugs PMD 代码评审工具 Jupiter（暂不讲解） CheckStyle简介 CheckStyle:主要用于检查代码规范目前版本5.1, 主站网址/ 有for eclipse的插件，插件下载网址是 /projects/eclipse-cs/files/Eclipse%20Checkstyle%20Plug-in/ 工作原理:检查源码,对javadoc,书写格式、基本错误等进行检查. 规则定义:默认的规则是sun的编码规范. 可以自定义规范. CheckStyle检查的问题 JavaDoc注释 命名约定 文件头 Imports 长度限制 空格 关键字 对区域(empty block)的检查 编码的检查（魔法数、switch中错误分支）等 重复的代码 各种量度 CheckStyle演示 演示checkstyle使用 查看checkstyle各个视图 演示checkstyle配置 详细讲解checkstyle检查内容，以sun标准为例进行讲解，详见附件 附件\Checkstyle4.mht Javadoc注释 JavaDoc注释 Javadoc Comments /** *Returns an codeInteger/code object * holding the value * @param s the string to be parsed. * @return an codeInteger/code * object holding the value * @exception NumberFormatException if the * string cannot be parsed. */ 命名约定 Java中命名采用驼峰命名方式，一般首字母小写其他后面单词首字母大写，如userName。 需要注意的是右边有不同 Import import中避免星号* 删除没用的import 此项可以通过eclipse中 ctrl+shift+o功能进行处理 长度限制 FileLength 文件长度 默认2000行 每行长度 默认80个字 方法长度 默认150行 方法的参数个数 默认7个 关键字key word 关键字的出现顺序 public static final XXX 是对一个常量的声明。如果使