The coding standards checker is a plugin designed for use in eclipse to check if a code document conforms to the coding standards for the language of the document. The plugin has been designed to be easy to use with functionality similar to that of a spell checker. The coding standards checker has functionality to replace or ignore singular coding errors or to replace all errors in a document at once. The checker displays a window with the suggested formatting of a particular error, highlighting the suggestion within the context of the document. At the same time in the currently opened document, the error is highlighted. The current functionality of the coding standards checker allows for the following;

• Correcting Indentation
• Formatting of multiple statements (on one line) onto multiple lines (1 statement per line)
• Allows individual formatting rules for different blocks of code (e.g. for loops, method blocks)
• Generality to different programming languages (by specifying an xml standards file for a particular langauge)

System Requirements

• Java 1.4 or higher
• Eclipse 3.0 or higher
• Windows or Linux operating system

Installation

• Download the CodingStandards1_0.zip file and extract the org.eclipse.gen.codingstandards_1.0.0.jar to the plugins folder of the eclipse installation directory
• Once the jar file has been copied into the plugins folder, launch eclipse.
• The coding standards icon (fish) should now be visible on the top taskbar.
• In order for the coding standards checker to check a document, there must be an xml standards file in the home directory under the folder named "Standards". (The home directory is home/ under linux and C:\Documents and Settings\(User name)\ under windows)
  Ensure that the folder and xml standards file are present before launching the plugin.

Documentation

All documentation and code for the current build 1.0 can be found in the zip here.

Developers Guide [doc] [pdf]

User Guide [doc] [pdf]

Installation Guide [txt]

Requirements Document [html]