本主题介绍了代码审查 UI 如何呈现代码审查任务,提供了如何操作分配任务的概述,并解释了如何自定义 UI 以满足特定首选项。 

本章包含:

关于代码审查 UI 

可以使用代码审查透视图或产品特定透视图中的代码审查功能。 

若要打开代码审查透视图,请执行其中一项以下操作:

  • 单击快捷栏中的 Open Perspective 按钮,选择 Other,然后在打开的 Select Perspective 对话框中选择 Code Review 。
  • 选择 Window> Open Perspective> Other ,然后在打开的 Select Perspective 对话框中选择 Code Review 。
  • 如果以前打开了此透视图,则单击快捷栏(工作平台右上方)中的 Code Review 按钮。

Parasoft 测试提供了以下视图来促进代码审查:


  • Quality Tasks view – 在编码审核模式下,该视图显示代码审查任务树。它呈现两种类型的任务:审阅者查看需要审查的代码修订的“审查”任务,作者查看响应审阅者评论的“修复”任务。此视图应该默认开启;若要使它进入编码审核模式,单击视图工具栏中的 Code Review  或 User Code Review 按钮。



  • Code Review Issue 允许团队成员添加和查看关于所提交代码修改的代码注释。这允许作者和审阅者就如何修改所提交修订版进行对话。若要访问该视图,请选择 Parasoft> Show View> Code Review Issue
  • Compare Editor – 突出显示文件最近版本和源码控制存储的以前版本之间的差异。在提交后(post-commit)模式下,它显示报告的两个或两个以上修订版之间的差异,其中需要审查。它还显示桌面上的本地更改和源码控制下的以前版本之间的差异。双击代码审查树中特定的修订版时,将打开比较编辑器。

将代码审查任务导入到 UI

根据导入设置,代码审查任务可能在导入质量任务(如 将结果导入 UI中所述)时自动导入。

可以总是将分配的代码审查任务导入到 Quality Tasks view 中,通过选择 Parasoft> Import> [desired_import_option] 或单击 Import My Recommended Tasks 工具栏按钮。如果选择导入自定义任务集,请保证启用了 Code Review 选项。


了解任务状态指示器

根据对代码审查任务树的配置,每个代码审查任务都可以用状态指示器(和文件名、修订版本号以及最新修订版提交到源码控制的时间)标记。




下表描述了所使用的各种状态指示器:

操作说明
To Review指示应对修订包执行审查。
To Fix指示应在修订包中包含的文件中进行一些改进。
Monitor指示指定的监视器应审查修订包中包含的文件的状态。
Waiting指示修订包正在等待某人的操作。
Done如果希望现实这样的任务,则需要在首选项面板(查阅 Configuring Code Review Preferences)中设置 Show completed tasks by 选项。

处理任务或任务集

处理任务的主要方法是双击代码审查任务树节点,或者单击该任务并选择合适的快捷菜单命令。可以处理任务集(如,代码审查包中的所有代码审查任务)、单个代码审查任务(如,要审查的单个修改或要处理的审查者注释),或者介于两者之间的任务。

可用操作

根据右键单击不同的代码审查任务树项目和特定角色,可以使用不同的快捷菜单命令。与角色相关的命令将在作者和审阅者的主题中进行讨论。总的来说,快捷菜单可用于执行如下操作:

  • 将任务重新分配给其他团队成员。
  • 删除任务。
  • 从一个任务导航到下一个(或上一个)任务。
  • 展开或折叠树。
  • 更改树布局。
  • 屏蔽完成的、取消的或拒绝的任务。
  • 打开比较编辑器,突出显示文件最近版本和源码控制存储的以前版本之间的差异。
  • 添加新审阅者。
  • 打开审阅者添加的注释。

例如,使用以下任务的审阅者可能选择 Compare with Previous 



审查比较编辑器中的代码变更,



然后在代码审查问题区域添加一个问题。

随后,作者可能会打开该评论,然后在代码审查问题区域进行响应。

将操作应用于多个任务

如果右键单击一个表示项目组(例如,特定文件的所有审阅)的代码审查任务树节点,则可以使用单个命令对该组所有合适项目执行相同的操作。例如,如果希望屏蔽包中所有活跃的代码审查任务(如“已完成”),那么可以这样做:

自定义代码审查任务树

有许多方法可以配置代码审查任务树,以满足您的需求和首选项。

布局模板调整

若要自定义显示或隐藏哪些元素,可以选择、配置和自定义布局模板,其在 Changing the Display Format and Contents中有所描述。

示例代码审查布局

可以按文件、日期、提交者或评论来组织代码审查布局。

我们鼓励您尝试为每个视图尝试不同的布局,直到找到最适合您的那个。这是开发人员用于代码审查的一些示例布局。

例如,以下截图显示一种可能的代码审查配置:



这是由开发人员配置的,它尝试让布局按开发人员、任务和代码中的位置查看内容的方式对项目进行分组。  这就是他的大脑分解信息的方式,这就是我们想要呈现的方式。更具体地说:

  • 顶级节点显示,审查由开发人员审查人员分解。这有助于区分他编写的代码审查和他需要执行的审查。
  • 第二级节点告诉他审查的日期。
  • 第三级节点显示提交或预提交注释,指示代码作者正在处理什么。
  • 第四级和第五级节点依次对文件所在代码中的位置进行更细粒度的分解。
  • 第六级节点指示实际文件,以及审查中该文件的当前状态。

寻找更简单的对等代码审查布局的开发人员可能决定只有 4 个级别的信息:

  • 指定代码审查任务节点。
  • 审查日期。
  • 指示代码作者正在处理什么的提交或预提交注释。
  • 实际文件,以及审查中该文件的当前状态。

其他关注 1)首先处理什么代码审查 2)每个代码修改的目的是什么的开发人员可能有以下布局:



该布局显示 "Task Type” 和 "Task or Comment"。"Task Type”按日期对签到进行分类,它允许审阅者查看首先审查哪个代码。"Task or Comment”按包括作者评论进行分类,显示签到的目的。

标签装饰

若要微调要显示的各种树节点中呈现的数据,可以使用首选项面板的代码审查控件来配置显示哪些标签。


筛选器

此外,可以通过单击 Quality Tasks 视图中的 Filter  按钮, 



然后指定所需筛选条件,从而对内容进行筛选。


  • No labels