You can create reports of code review findings by exporting the
data in the findings to a reports directory. The reports are viewable in a
browser.
Note: You must have the Adobe SVG Viewer plugin installed to view
all the information in the reports.
Before you can create a code review
report, you must have a workspace with Java source code in it and run a code
review on the workspace using the graphical user interface.
To export code review findings to reports:
- In any perspective, click .
The Code Review Export wizard opens. (You can also click
the Export icon
in the toolbar for the Code Review view.)
- In the Destination folder field, browse
to the location of the reports folder that will contain the code review reports.
Or, browse to a location of your choice, and create a reports folder.
- Under Type, select the report template.
The options are:
- Score Card: A high-level summary of the number and severity
of rules used in the code review findings
- Complete HTML: A high-level summary, and a detailed description
of all the findings in the code review (a combination of the Score Card and
Detailed HTML reports)
- XML: A detailed description of the findings in XML format
- Detailed HTML: A detailed description of the findings
- Click Next. The files that were analyzed
in the code review and produced findings are displayed and selected. Do any
of the following actions:
- To exclude the results of the analysis on a file from the report,
clear the check box next to that name.
- To include the results of the analysis on a file in the report, select
the check box next to that file name.
- To select all of the files, click Select All .
- To deselect all of the files, click Deselect All .
- Click Finish. The report is displayed in
a browser. The report contains only information about the files you selected
in step 4 as well as the files that did not produce findings.
Note: Files that did not produce any findings in the code review
are also included in the reports.
You can set the styles of the headings
and sections in the reports by opening the Code Review preferences page, expanding
Code
Review, and clicking
Report Styles.