Coding Standards
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
Check Style 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
Check Style specification:
- Mobius minimal CheckStyle specification (to upload next week by Joe K?)
Each site or project may define a stronger set of rules. Please provide a snapshot of the relevant specifications here.
Site-specific Standards
University College Dublin
- 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.
I will provide a proposed minimal Mobius configuration next week.
--
JosephKiniry - 13 Jun 2007
Documentation Standards
Each of the components and subsystems has a short summary on the MOBIUS wiki
Component Index.
--
AleksySchubert - 13 Jun 2007
