CodeReview工具Jupiter的使用.docVIP

亿阳信通 Code Review工具Jupiter的使用 部 门： 通用产品线 撰 写： 刘超 文档编号： Code Review工具Jupiter的使用 密级：保密 文档状态：正式版 V1.0 文档修改记录 版本号 主要作者 修改记录 完成日期 1.0 刘超 新建Code Review工具Jupiter的使用文档 2010-03-17 目录 1概述 4 2目的 4 3适用范围 4 4基本原则 4 5角色职责 5 6评审内容 5 7安装Jupiter 6 8使用Jupiter进行代码评审 6 8.1准备代码 7 8.2代码评审 10 8.3会议讨论 12 8.4修改代码 13 8.5记录结果 14 1概述 什么是代码评审（CodeReview）? 代码评审也称代码复查，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。 Jupiter提供了代码行级别的评审批注功能，方便评审参与人了解具体是哪些行代码存在问题。 同时，它也比较符合常规的评审流程，被评审人提供待审代码-评审人线下提出个人意见-组织讨论会讨论每个人提出的意见并确定问题及解决方案-被评审人rework修改代码-评审人查看修改情况。 Jupiter支持在一个项目中的多次评审，多人协同参与评审，支持多种配置库如SVN、CVS等，支持简单的评审流程，支持问题跟踪。 2目的 定期进行CodeReview可以有效的降低开发风险，除此之外，代码评审还有以下好处： 提高代码质量 在项目的早期发现缺陷，将损失降至最低 评审的过程也是重新梳理思路的过程，双方都加深了对系统的理解 促进团队沟通、促进知识共享、共同提高 3适用范围 所有研发部门 4基本原则 没有人否认CodeReview对提高代码质量的作用，但是如何进行CodeReview? 这里确实存在一些方法和技巧。方法不当，会浪费大量时间、造成低效率；流程过紧，会大大降低生产力，流程过松，很难知道CodeReview的效果，甚至有没有进行CodeReview，都很难判断，这里有11条代码评审的最佳原则： 一次检查少于200～400行代码 努力达到一个合适的检查速度：每小时少于300～500行代码 有足够的时间、以适当的速度、仔细地检查，但不宜超过60～90分钟 在复审前，代码作者应该对代码进行注释 建立量化的目标并获得相关的指标数据，从而不断改进流程 使用检查表（checklist）肯定能改进双方（作者和复审者）的结果 验证缺陷是否真正被修复 管理人员要营造良好的氛围（文化），使大家可以积极地对待缺陷的发现，发现足够多的缺陷，只关心问题是什么、怎样引起的，而不关心是谁写的代码 清楚度量工具（Big Brother）的作用——度量工具是双刃剑，要小心使用 自我约束：即使没有时间完成所有代码的检查，也应该尽可能去做，哪怕是一部分 轻量级的code review是高效率的、可行的，并能有效地发现缺陷 5角色职责 开发组长：负责制定CodeReview计划，安排CodeReview活动职责分工，组织进行CodeReview，确保按CodeReview过程和规范执行。 开发人员：依据 CodeReview计划和CodeReview过程和规范执行 CodeReview活动。 6评审内容 编码规范问题 命名不规范、magic number、System.out. 代码结构问题 重复代码、巨大的方法和类、分层不当、紧耦合 工具、框架使用不当 Spring、Hibernate、AJAX 实现问题 错误验证、异常处理、事务划分、线程、性能、安全、实现过于复杂、代码可读性不佳、扩展性不好 测试问题 测试覆盖度不够、可测试性不好 注：代码评审不负责检查功能、逻辑是否正确，这些要靠单元测试和QA工作来解决 7安装Jupiter Jupiter作为Eclipse的插件，安装起来非常方便，只需拷贝edu.hawaii.ics.csdl.jupiter_3.2.1.jar至$ECLIPSE_HOME/plugins目录下，重启Eclipse即可，如果看到Eclipse的工具栏上出现了Jupiter的图标，则表示安装成功 8使用Jupiter进行代码评审 代码评审分为两种方式，一种是交叉评审，另一种是代码会审。 交叉评审又称为代码走查，即团队成员互相检查代码，参与者可以是任意两个组员，或开发组长分别与每个组员结对进行，时机可以选择在下班前半小时，对当天改动的模块进行评审，代码作者讲解如何以及为何这样实现、评审者提出问题和建议，每次解决的问题要记录到SVN或CVS服务器，每次评审代码不宜太多，否则会事倍功半。 代码会审主要用于开发阶段的重点模块集中Review，