codereview工具jupiter的使用

《codereview工具jupiter的使用》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、亿阳信通CodeReview工具Jupiter的使用部门：通用产品线撰写：刘超文档编号：CodeReview工具Jupiter的使用密级：保密文档状态：正式版V1.0文档修改记录版本号主要作者修改记录完成日期1.0刘超新建CodeReview工具Jupiter的使用文档2010-03-17目录1概述42目的43适用范围44基本原则45角色职责56评审内容57安装Jupiter68使用Jupiter进行代码评审68.1准备代码78.2代码评审108.3会议讨论128.4修改代码138.5记录结果141概述什么是代码评审（CodeReview）?代码评审也称代码复查，

2、是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Jupiter提供了代码行级别的评审批注功能，方便评审参与人了解具体是哪些行代码存在问题。同时，它也比较符合常规的评审流程，被评审人提供待审代码->评审人线下提出个人意见->组织讨论会讨论每个人提出的意见并确定问题及解决方案->被评审人rework修改代码->评审人查看修改情况。Jupiter支持在一个项目中的多次评审，多人协同参与评审，支持多种配置库如SVN、CVS等，支持简单的评审流程，支持问题跟踪。2目的定期进行CodeReview可以有效的降低开发风险，除此之外，代码评审还有以下好处：u提高

3、代码质量u在项目的早期发现缺陷，将损失降至最低u评审的过程也是重新梳理思路的过程，双方都加深了对系统的理解u促进团队沟通、促进知识共享、共同提高3适用范围所有研发部门4基本原则没有人否认CodeReview对提高代码质量的作用，但是如何进行CodeReview?这里确实存在一些方法和技巧。方法不当，会浪费大量时间、造成低效率；流程过紧，会大大降低生产力，流程过松，很难知道CodeReview的效果，甚至有没有进行CodeReview，都很难判断，这里有11条代码评审的最佳原则：u一次检查少于200～400行代码u努力达到一个合适的检查速度：每小时少于300～500

4、行代码u有足够的时间、以适当的速度、仔细地检查，但不宜超过60～90分钟u在复审前，代码作者应该对代码进行注释u建立量化的目标并获得相关的指标数据，从而不断改进流程u使用检查表（checklist）肯定能改进双方（作者和复审者）的结果u验证缺陷是否真正被修复u管理人员要营造良好的氛围（文化），使大家可以积极地对待缺陷的发现，发现足够多的缺陷，只关心问题是什么、怎样引起的，而不关心是谁写的代码u清楚度量工具（"BigBrother"）的作用——度量工具是双刃剑，要小心使用u自我约束：即使没有时间完成所有代码的检查，也应该尽可能去做，哪怕是一部分u轻量级的codere

5、view是高效率的、可行的，并能有效地发现缺陷5角色职责u开发组长：负责制定CodeReview计划，安排CodeReview活动职责分工，组织进行CodeReview，确保按CodeReview过程和规范执行。u开发人员：依据CodeReview计划和CodeReview过程和规范执行CodeReview活动。6评审内容u编码规范问题命名不规范、magicnumber、System.out.u代码结构问题重复代码、巨大的方法和类、分层不当、紧耦合u工具、框架使用不当Spring、Hibernate、AJAXu实现问题错误验证、异常处理、事务划分、线程、性能、安全

6、、实现过于复杂、代码可读性不佳、扩展性不好u测试问题测试覆盖度不够、可测试性不好注：代码评审不负责检查功能、逻辑是否正确，这些要靠单元测试和QA工作来解决7安装JupiterJupiter作为Eclipse的插件，安装起来非常方便，只需拷贝edu.hawaii.ics.csdl.jupiter_3.2.1.jar至$ECLIPSE_HOME/plugins目录下，重启Eclipse即可，如果看到Eclipse的工具栏上出现了Jupiter的图标，则表示安装成功8使用Jupiter进行代码评审代码评审分为两种方式，一种是交叉评审，另一种是代码会审。交叉评审又称为代码

7、走查，即团队成员互相检查代码，参与者可以是任意两个组员，或开发组长分别与每个组员结对进行，时机可以选择在下班前半小时，对当天改动的模块进行评审，代码作者讲解如何以及为何这样实现、评审者提出问题和建议，每次解决的问题要记录到SVN或CVS服务器，每次评审代码不宜太多，否则会事倍功半。代码会审主要用于开发阶段的重点模块集中Review，它采用的是正式的会议Review，参与者包括项目组全体成员，其它组的开发组长也应尽量参加，时机选择，一般是开发进行到某一阶段时，对共性问题进行总结，对好的做法进行提炼和推广。二者的评审流程基本一致，区别在于代码会审要开会讨论审查结果，下

8、面就以会议