Supported features

The code review component includes features for creating and enforcing coding rules for EGL in the Linux™ and Windows™ environments.

Features

Features of code review 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™
Product workbench ✔ ✔
Code review application ✔ ✔
Support for EGL ✔ ✔
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 XML 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 EGL editor.
    • Support in the EGL editor:
      • 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
    • 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 EGL language elements, in either AST or IR format, of a source code file when it is being reviewed.
      • Support of all EGL language elements

Supported perspectives

In the product workbench, the following perspectives are supported:
  • EGL Development
  • Debug
  • Java
  • Java EE
  • Plug-in Development
  • Resource

Supported editors

The following editors are supported:
  • EGL 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 code review.
  • Find and fix problems that are detected by a code review.
Note:
Some menu items and descriptions are not localized in the Arabic version of IBM Business Developer V9.5.