In a software analysis, a configurable
set of coding rules is applied to a specified group of source code
files. Results are generated that identify lines of source code that
violate a rule.
Software analysis configuration
The software analysis is guided by a software
analysis configuration, which is created in the software analysis configuration window. The configuration
contains two types of information:
- Scope
- The scope identifies the source code files to which the software
analysis is to be applied.
- Rules
- The rules are a set of coding requirements.
Baseline analysis configuration
In
a baselined code review, the code review run time searches only for
rule violations that were introduced by changes to a previous version.
The previous version is the baseline.
The baselined
analysis is guided by a
baseline analysis configuration,
which is created in the
software analysis configuration window.
A baseline analysis configuration consists of two items.
- A software analysis configuration: The
software analysis configuration is the same type of entity that is
described in the preceding topic. It contains a set of rules to be
applied and a scope that identifies the source code files to be checked.
- A baseline archive: The baseline archive
contains the results of applying the same set of rules to a previous
version of the same source code.
Running code reviews
In the
product workbench, you can run a code review from the software analysis configuration window, from the project explorer
view, or from a supported programming language editor. The results
show as a report in the Software Analyzer Results view.
Each result includes the name of the source code file, the line number,
and the rule that was violated. Clicking a result opens the source
code file in the appropriate editor at the problem location.
The
following features are available:
- Results can be preserved by generating a report in PDF or HTML
format.
- Results can be exported to a file in XML,
CSV, or JUnit XML format.
- Software analysis configurations can be distributed to workstations
with push-to-client. (Baseline analysis configurations cannot be distributed
with push-to-client.)
Code review application
With
the code review application, you run a code review from a Linux or Windows command
line or from a JCL file in the z/OS® environment. The
following features are available:
- Batch capability
- Analysis of files inside or outside of the product workspace
- An include list and an exclude list of individual source code
files
- Generation of output data files in XML and CSV format