This topic introduces how the Code Review UI presents code review tasks, provides an overview of how you can take action on your assigned tasks, and explains how to customize the UI to meet your specific preferences.
Parasoft Test provides the following provides the following views to facilitate code reviews:
Depending on your import settings, your code review tasks may be imported automatically when you import your quality tasks (as described in Importing Results into the UI).
You can always import your assigned code review tasks into the Quality Tasks view by choosing Parasoft> Import> [desired_import_option] or clicking the Import My Recommended Tasks toolbar button. If you choose to import a custom set of tasks, be sure to enable the Code Review option.
Depending on how you configure the code review tasks tree, each code review task may be marked with a status indicator, as well as the name of the file, the revision version number, and the time when the latest revision was committed into the source control.
The following table describes the various status indicators used:
|To Review||Indicates that a review should be performed on the revision package.|
|To Fix||Indicates that some improvements should be made within the files included in the revision package.|
|Monitor||Indicates that the designated monitor should review the status of files included in the revision packages.|
|Waiting||Indicates that your revision package is waiting for someone's action.|
|Done||If you want such tasks to be shown, you need to set the Show completed tasks by option in the Preferences panel (see Configuring Code Review Preferences).|
The main ways to take action on a task are to double-click a code review task tree node, or right-click it and choose the appropriate shortcut menu command. You can take action on a set of tasks (such as all code review tasks for a code review package), a single code review task (such as a single modification to review or reviewer comment to address), or anything in between.
Different shortcut menu commands are available depending on what code review task tree item you right-click and your specific role. Role-relevant commands are discussed in the topics for authors and reviewer. Generally, shortcut menus can be used to perform actions such as:
For example, a reviewer with the following task might choose Compare with Previous
review the code change in the compare editor
then add an issue in the Code Review Issue area.
The author might then open up that comment, then respond to it in the Code Review Issue area.
If you right-click a code review task tree node that represents a group of items (for instance, all reviews for a specific file), you can use a single command to perform the same action on all appropriate items in that group. For example, if you want to mark all active code review tasks in a package as "done," you could do as follows:
There are numerous ways to configure the code review tasks tree to suit your needs and preferences.
To customize which elements are shown or hidden, you can select, configure, and customize layout templates, which are described in Changing the Display Format and Contents.
You can organize the code review layout by file, by date, by committer, or by comment.
We encourage you to experiment with different layouts for each view until you find the one that works best for you. Here are some sample layouts that developers use for code review.
For instance, the following screenshot shows one possible configuration for Code Review:
This was configured by a developer trying to group items in a way that lets him to look at things by developer, then by task, and then by location in the code. That’s how his brain breaks down the information, so that’s how we wanted it presented. More specifically:
A developer looking for a simpler peer code review layout might decide to have only 4 levels of information:
Another developer who wants to focus on 1) what code reviews to address first and 2) what each code modification was designed to achieve might have the following layout:
This layout shows the "Task Type" and the "Task or Comment." The "Task Type" sorts the check-ins by date, allowing the reviewer to see which code review to look at first. The "Task or Comment" shows him the intent of the check-in by including the author's comment.
To fine-tune what data is displayed in the various tree nodes that you choose to display, you can use the Preferences panel’s Code Review controls to configure which labels are displayed.
Additionally, you can filter the content shown by clicking the Filter button in the Quality Tasks view
then specifying the desired filter conditions.