代码评审工具jupiter使用流程

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

1、代码评审工具Jupiter的使用部门：银行产品开发部撰写：王建华文档编号：代码评审工具Jupiter的使用文档状态：正式版V1.0文档修改记录版本号主要作者修改记录完成日期1.0王建华新建代码评审工具Jupiter的使用文档2012-03-291.1王建华根据最新的插件界面更新文档，完善了使用流程和记录导出功能2012-04-16目录1概述42目的43适用范围44基本原则45角色职责56评审内容57安装Jupiter78使用Jupiter进行代码评审78.1准备代码78.2代码评审128.3会议讨论138.4修改代码138.5

2、记录结果141概述什么是代码评审（CodeReview）?代码评审也称代码复查，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Jupiter提供了代码行级别的评审批注功能，方便评审参与人了解具体是哪些行代码存在问题。同时，它也比较符合常规的评审流程，被评审人提供待审代码->评审人线下提出个人意见->组织讨论会讨论每个人提出的意见并确定问题及解决方案->被评审人修改代码->评审人查看修改情况。Jupiter支持在一个项目中的多次评审，多人协同参与评审，支持多种配置库如SVN、CVS等，支持简单的评审流程，支持

3、问题跟踪。2目的定期进行CodeReview可以有效的降低开发风险，除此之外，代码评审还有以下好处：u提高代码质量u在项目的早期发现缺陷，将损失降至最低u评审的过程也是重新梳理思路的过程，双方都加深了对系统的理解u促进团队沟通、促进知识共享、共同提高3适用范围所有研发部门4基本原则没有人否认CodeReview对提高代码质量的作用，但是如何进行CodeReview?这里确实存在一些方法和技巧。方法不当，会浪费大量时间、造成低效率；流程过紧，会大大降低生产力，流程过松，很难知道CodeReview的效果，甚至有没有进行CodeR

4、eview，都很难判断，这里有10条代码评审的最佳原则：u一次检查少于200～400行代码u努力达到一个合适的检查速度：每小时少于300～500行代码u有足够的时间、以适当的速度、仔细地检查，但不宜超过60～90分钟u在复审前，代码作者应该对代码进行注释u建立量化的目标并获得相关的指标数据，从而不断改进流程u使用检查表（checklist）肯定能改进双方（被评审人和评审人）的结果u验证缺陷是否真正被修复u管理人员要营造良好的氛围（文化），使大家可以积极地对待缺陷的发现，发现足够多的缺陷，只关心问题是什么、怎样引起的，而不关心是

5、谁写的代码u自我约束：即使没有时间完成所有代码的检查，也应该尽可能去做，哪怕是一部分u轻量级的codereview是高效率的、可行的，并能有效地发现缺陷5角色职责u评审组织者：负责制定CodeReview计划，安排CodeReview活动职责分工，组织进行CodeReview，确保按CodeReview过程和规范执行。u评审人和被评审人：依据CodeReview计划和CodeReview过程和规范执行CodeReview活动。6评审内容u工具检查□Eclipse警告□FindBug□CheckStyle□Jupiter□Sub

6、clipse或者Subversiveu代码注释内容（详细参考《代码注释规范》）□类注释内容□接口注释内容□方法注释内容□方法内部注释内容u业务逻辑□业务逻辑实现的正确性□业务逻辑实现的完整性u代码细节u异常处理□接口方法声明需要抛出BusinessException□接口实现类最外层需要强制try….catch,对Exception进行marshBusinessException包装□禁止出现try….catch后，没有对异常做任何处理的情况□在EJB边界对所有的异常进行marshBusinessException包装□后台所

7、有方法不再显示的进行异常的抛出声明，如有异常用wrappBusinessException包装成运行时异常直接抛出□前台代码直接抛出后台传递过来的异常□前台代码主动抛异常时，需要使用ExceptionUtils.wrappBusinessException;□前后台异常处理类统一使用nc.vo.pubapp.pattern.exception.ExceptionUtils□未用异常作为业务流程转换的判断u效率□接口的定义使用参数数组来进行批量调用，而不是循环调用非批量接口□方法内部禁止出现循环执行相似重复的SQL语句□尽量使用

8、绑定变量的sql□sql关联的表不超过3个□sql不采用外连接u内存□UFDobule常量必须使用UFDouble.ZERO,UFDouble.ONE□UFBoolean常量必须用UFBoolean.TRUE,UFBoolean.FALSE□UFBoolean的值必须采用UF