Rational Developer for System z

Overview of the code review application

This topic provides an overview of the code review application.

Features

The code review application is invoked from the Linux or Windows command line. Its capabilities are similar to those of the code review process that is launched from the user interface of the product workbench. It supports the same language-specific standard rules for COBOL and PL/I, the same types of custom rules and categories for COBOL and PL/I, and the same types of user-written custom rules for COBOL. It uses the same rule severities and has the same concepts of scope.

The code review application includes the following additional features:
  • Analysis of source code files located either inside or outside the product workspace.
  • Batch support for processing multiple projects or directories in one invocation.
  • Support for include lists and exclude lists of specific source code files.
  • Generation of XML and CSV data output files that can be used as source files for other applications.
  • A sample script that provides a working example of how to invoke the code review application.

Steps for running the code review application

The high-level steps for running the code review application are as follows. The details of the process are described in subsequent help topics:
  1. Create a rule file by exporting rule information in the analysis configuration editor. See Exporting or importing a set of rules.
  2. Decide on the values that you want to use as parameters when you invoke the code review application, such as the workspace, the projects or directories where the source code files are located, and the paths of the rule file and the output file. See Parameters of the code review application.
  3. Open a console window in Linux or Windows.
  4. Enter the command to run the code review application. Wait for it to complete. See Syntax for invoking the code review application. Initially you might want to use the sample script to invoke the application. See Running the sample script.
  5. View the contents of the output file and the generated data files. See Using the output data files and Using the output information.

Processing of Java source files

The code review component of Developer for System z® does not explicitly support Java™ source code files and does not document support for Java. However, the code review application (like the code review analysis configuration editor) does recognize and process Java code review rules and Java source code files to some degree. If a rule file includes Java code review rules, and Java source code files are included in the scope, then the code review application includes the Java results in its output information and in its output data files.


Feedback