Reference

This section contains topics that describe code review user interface elements and supplied code reviews.

Prerequisites to run a code review
When you choose the code base to run a code review on, the code must meet certain prerequisites; most importantly, all files in the code base must be compilable when you run the review.

Types of code review
The following code reviews are predefined with specific rules and rule categories that focus on aspects of software quality (such as globalization) and software properties (such as severity).

Code Review view
Use the Code Review view to choose what code to review and then to examine the findings produced by the code review. In this view, you can filter, sort, and search.

Code Review Details view
The Code Review Details view provides resource and troubleshooting information about the selected finding.

Progress view
The Progress view shows status information for background and processing tasks for deep rules in the J2EE Best Practices code review. Deep rules not only produce findings, but also show the paths that lead to the findings. These rules require data flow analysis, the method that traces the paths to a finding. Consequently, this review can take longer than other code reviews. The Progress view indicates the task that is being performed and its progress.

Java preferences - Code Review page
Use the Code Review page in the Preferences window to select which code review to run. On this page, you also configure the rule set by disabling rules you do not want applied in the review and modifying rule properties.

Filters window
Use the Filters window to clear the status or severity level of findings so that you do not see findings with those properties.

New Code Review Rule wizard
The New Code Review Rule wizard provides templates so you can create rules that are specific to your application, and then incorporate these custom rules into the code review.

Export Code Review configuration window
Use the Export Code Review configuration window to export a customized rule configuration to a zipped file. Other team members can import the configuration so that everyone can run consistent code reviews that apply exactly the same rules and settings.

 

Parent topic

Reviewing code automatically