The Code Review component includes features for creating
and enforcing coding rules for COBOL or PL/I in
the Linux, Windows, and z/OS® environments.
Features
Table 1 summarizes
the features that are available in each environment. The features
are explained in more detail in the text that follows the table.
Table 1. Features of Code Review| Features |
Linux |
Windows |
z/OS |
| Product workbench |
✓ |
✓ |
No |
| Code review application, with batch capabilities |
✓ |
✓ |
✓ |
| Support for COBOL and
PL/I |
✓ |
✓ |
✓ |
| User-written rules |
✓ |
✓ |
✓ |
- The product workbench in the Linux and Windows environments includes
the following features:
- An analysis configuration window for creating reusable profiles
for reviewing code:
- Controls for specifying the source code files to be reviewed and
the coding rules to be applied.
- Selectable built-in coding rules with severity levels.
- Configurable built-in custom rules.
- Built-in and custom categories for organizing coding rules.
- A Software Analyzer Results view for displaying
code review results and generating reports:
- Retention of multiple code review results while the development
workbench is running.
- A setting for filtering the display of
results.
- Reports of the results of a code review, in HTML or PDF format.
- Links from code review results directly to the source code files
in which the results were found. The source code file is opened in
the System z® LPEX, COBOL, or PL/I editor.
- Support in the System z LPEX, COBOL, and PL/I editors:
- Marking lines of source code that contain problems with highlighted
text and bookmarks.
- Quick access to the problem lines in a source code file that is
flagged by a code review result.
- Quick rerunning of a code review to verify fixes.
- One-at-a-time code review of remote source code files.
- Distribution of code review profiles:
- Export and import of code review profiles.
- Distribution of code review profiles to clients
with push-to-client software (software analysis configurations only).
- User-written rules. The following features are included:
- Quick generation of plug-in projects for developing user-written
rules.
- Generation of Java™ source
code files that provide a framework for a user-written rule.
- A Java API that provides
classes for user-written rules.
- A Java API for accessing
the COBOL or
PL/I language elements of a source code file when it is being
reviewed.
- Support of most COBOL and
PL/I language elements.
- The command-line code review application in the Linux and Windows environments runs a software analysis
configuration or a baseline analysis configuration.
It includes the following features:
- Support for language-specific standard rules, for custom rules
and categories, and (with COBOL) for
user-written rules.
- Batch support for processing multiple projects or directories.
- Scope options for processing projects, directories, or all the
projects in the workspace.
- Support for include lists and exclude lists of specific files.
- Data output files in XML, CSV, or JUnit XML
format.
- In the z/OS environment,
the command-line code review application has the same features as
the code review application in the Linux and Windows environments. It generates
equivalent results. See the related links.
Supported perspectives
In
the product workbench, the following perspectives are supported:
- AIX COBOL
- Enterprise Development
- Debug
- Java
- Java EE
- Plug-in Development
- Resource
- z/OS Projects
Supported editors
The following editors are supported:
- Basic LPEX editor
- COBOL editor
- PL/I editor
- System z LPEX editor
From these editors, you can do the following tasks:
- Open the software analysis configuration window to create
a configuration or modify an existing one.
- Run an existing software analysis configuration.
- Find and fix problems that are detected by a code review.