CodingStandard

WikiInclude(CodingStandardDescription)

Mobius tool developer uses source, documentation, and specification coding standards. Such a standard should be described in plain English in a coding standard document, either shipped with or pointed to (via a URL) a given Mobius component. An example of such a detailed standard from UCD is provided below.

Each site standard has two halves that work together: an Eclipse code formatter specification (and, optionally, an Emacs specification) which helps the Mobius PVE (or Emacs) format code as it is written or as it is automatically reformatted and a CheckStyle specification that describes how the code and documentation should look. I.e., naively writing code using the Eclipse formatter should result in code that passes the syntactic rules in its complementary CheckStyle specification.

Minimal Mobius Coding Standard

All Mobius code must obey a relatively weak set of rules defined via the following CheckStyle specification:

• Mobius minimal CheckStyle specification

Each site or project may define a stronger set of rules. Please provide a snapshot of the relevant specifications here.

Standards

• UCD's coding standard can be thought of as the most detailed/proscriptive coding standard within Mobius. It is encoded below in both an Eclipse code formatter and a CheckStyle specification.

• UCD CheckStyle coding standard specifications: * For CheckStyle 5.x: mobius-checkstyle-5.0.xml * For CheckStyle 4.x: mobius-checkstyle-4.2.xml * For CheckStyle 2.x: mobius-checkstyle-2.4.xml

• UCD Eclipse code formatter specification: UCD-Mobius_Eclipse_code_formatting_specification.xml

• Inria CheckStyle coding standard specifications: * For CheckStyle 5.x: mobius-inria-checkstyle-5.0.xml * For CheckStyle 4.x: mobius-inria-checkstyle-1.xml

Version: 18 Time: Tue Sep 29 16:25:26 2009 Author: jcharles (kiniry) IP: 137.43.154.79