Skip to topic
|
Skip to bottom
IST-15905
Tools Web
Mobius Public Home
Mobius Intranet
Tools Web Home
Overview
Tools Summary
Tools Contacts
Component Index
Related Tools
Download Tools
Scientific Issues
Tools Publications
Project Management
Development Schedule
Project Status
Documentation And Coding Standards
Latest News
Tools Meetings
Site Visits
GForge
Tools
Index
Search
Changes
RSS Feed
Statistics
Preferences
Edit Toolbar
Help
Start of topic |
Skip to actions
---+ 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 [[CheckStylePlugin][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 <nop>CheckStyle specification. ---++ Minimal Mobius Coding Standard All Mobius code must obey a relatively weak set of rules defined via the following [[CheckStylePlugin][CheckStyle]] specification: * Mobius minimal <nop>CheckStyle specification (to upload next week by JoeK) 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 * [[http://secure.ucd.ie/documents/whitepapers/code_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 <nop>CheckStyle specification. I will provide a proposed minimal Mobius configuration next week. -- Main.JosephKiniry - 13 Jun 2007 ---+++ Documentation Standards Each of the components and subsystems has a short summary on the MOBIUS wiki ComponentIndex. -- Main.AleksySchubert - 13 Jun 2007 * [[%ATTACHURL%/mobius-checkstyle-4.2.xml][mobius-checkstyle-4.2.xml]]: UCD <nop>CheckStyle 4.x coding standard specification * [[%ATTACHURL%/mobius-checkstyle-2.4.xml][mobius-checkstyle-2.4.xml]]: UCD <nop>CheckStyle 2.x coding standard specification * [[%ATTACHURL%/UCD-Mobius_Eclipse_code_formatting_specification.xml][UCD-Mobius_Eclipse_code_formatting_specification.xml]]: UCD Eclipse code formatter coding standard specification * [[%ATTACHURL%/mobius-inria-checkstyle-1.xml][mobius-inria-checkstyle-1.xml]] (4/07/07 version): Inria <nop>CheckStyle coding standard specification
End of topic
Skip to action links
|
Back to top
r1.6 :
Edit
|
Attach image or document
|
Printable version
|
Raw text
|
Page history
|
More actions
You are here:
Tools
>
DocumentationAndCodingStandards
to top
Ideas, requests, problems regarding the Mobius site