Jupiter 使用说明

Jupiter 是什么

Jupiter 是一个开源的、集成在Eclipse下执行代码审查工作的一个很棒的工具。
Jupiter工作分三个阶段:

  • Individual Phase 个人阶段,表示个人审查阶段。
  • Team Phase 团队阶段,表示团队审查阶段。
  • Rework Phase 修复阶段,表示修改Bug 阶段。

安装Jupiter

  • 在线安装 http://jupiter-eclipse-plugin.googlecode.com/svn/trunk/site/
  • 离线安装: http://code.google.com/p/jupiter-eclipse-plugin/downloads/list
    把下载到的jar文件拷贝到eclipse的plugins目录下,重启eclipse即可。
    如果出现如下图标,则表示安装成功:
    Jupiter 使用说明_第1张图片
    image.png

创建Review ID

  1. 什么是Review ID
    Review ID 代码一个审查任务,包涵了很多元素,比如审查任务名称、描述,审查那些代码文件,审查人,审查类型,级别设置等等。
  2. 创建Review ID流程
  • 在eclipse中选择要审查的项目,右键选择"属性"选项,进入Review,如下图:


    Jupiter 使用说明_第2张图片
    image.png
  • 右击右边的"New" 按钮出现填写框,可以填写ReviewID的名称,描述。如下图:


    Jupiter 使用说明_第3张图片
    image.png
  • 点击"Next>" 按钮进入下一步,选择对哪些代码文件进行审查,如下图:


    Jupiter 使用说明_第4张图片
    image.png
  • 点击"Next>" 按钮进入下一步,选择或者新输入审查人员,如下图:


    Jupiter 使用说明_第5张图片
    image.png
  • 点击"Next>"按钮进入下一步,指定Session的作者,但是一般选择所审查程序的编程人员。


    Jupiter 使用说明_第6张图片
    image.png
  • 点击"Next>"按钮进入下一步,选择"Type,Severity,Resolution,Status"的选项。


    Jupiter 使用说明_第7张图片
    image.png
  • 点击"Next>"按钮进入一下步,这里确定"Type,Severity,Resolution,Status"的默认选项,如下图:


    Jupiter 使用说明_第8张图片
    image.png
  • 点击"Next>"按钮进入下一步,输入最后生成的审查文件放置目录,建议使用日期加任务标记作为目录。


    Jupiter 使用说明_第9张图片
    image.png
  • 点击"Next>"按钮进入下一步,最后设置每个阶段的过滤器,每个项目可以根据项目的需要设定,这里默认不变。


    Jupiter 使用说明_第10张图片
    image.png
  • 点击"Finish"按钮完成ReviewID的设定,进入工程目录文件,可心发现目录中多出一个.jupiter文件,这个文件里面包含了上面配置所有信息。


    Jupiter 使用说明_第11张图片
    image.png

发布 Review ID

发布Review ID的过程其实就是配合SVN或都CVS或者其他版本控制系统,发布.jupiter文件。让其他项目组人员把该文件拷贝到相同目录。

获取Review ID

过通svn等版本控制,得到.jupiter文件

Individual Phase

Individual Phase的目标

个人阶段的目标:就是针对在ReviewID定义指定的审查人员对代码进行评审,并把评审结果上传到版本控制中。

Individual Phase的过程
  • 点击Jupiter的eclipse图标的下拉箭头,出现4个选项,选择1 Individual Phase,即可进入择ReviewID界面。如下图:


    Jupiter 使用说明_第12张图片
    image.png
  • 选择Review ID界面,如下图:


    Jupiter 使用说明_第13张图片
    image.png
  • 点击"Finish"按钮,进入Individual Phase视图,在左边"ReviewTable"视图中,选择待审查的代码文件。


    Jupiter 使用说明_第14张图片
    image.png
  • 通过点击 + 按钮添加评审记录。通过 - 按钮删除评审记录。


    Jupiter 使用说明_第15张图片
    image.png
  • 在打开的待评审代码文件中,右键问题代码行。在右键菜单中选择Add Review Issue.....,在右边Review Editor视图中选择"Type,Severity",描述代码问题。并保存


    Jupiter 使用说明_第16张图片
    image.png
  • 这时候可以看到代码中,问题行将出现紫色标记,鼠标放上去会出现问题说明。如图:


    Jupiter 使用说明_第17张图片
    image.png
结束 Individual Phase

个人审查阶段就是这样一个一个问题的叠加,直到你完成所有代码文件的审查工作,之后刷新工程目录,在目录下面会增加一个子目录,其中"-"的前一部分是ReviewID名称,后一部分XXX是执行Individual的审查者.提交.review文件到版本控制。


Jupiter 使用说明_第18张图片
image.png

Team Phase 阶段

Team Phase的目标

Team phase的目标就是把很多审查人的审查文件集合起来,然后开个评审会议,把问题讨论清楚,确认是否需要调整,或者给谁调整解决。

Team Phase过程
  • 进入Team Phase

你可能感兴趣的:(Jupiter 使用说明)