本主题介绍了代码审查 UI 如何呈现代码审查任务,提供了如何操作分配任务的概述,并解释了如何自定义 UI 以满足特定首选项。
本章包含:
可以使用代码审查透视图或产品特定透视图中的代码审查功能。
若要打开代码审查透视图,请执行其中一项以下操作:
Parasoft 测试提供了以下视图来促进代码审查:
根据导入设置,代码审查任务可能在导入质量任务(如 将结果导入 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 按钮,
然后指定所需筛选条件,从而对内容进行筛选。