Coding Standard

This article outlines the basic coding standard required on the Omneity project.

=Rationale= Coding standards ensure a consistent approach to presenting code, making it simpler for new developers to locate and read code and its associated documentation.

=Code= Code standards are enforced using Checkstyle. All submissions must pass the projects Checkstyle standards. This should not be too problematic if your development environment is configured properly for the project as you will be notified of coding standard issues as you code.

=Documentation= Document for the project is divided into broadly three sets:


 * 1) JavaDocs for API documentation
 * 2) This Wiki for programming guidelines, usage, etc.
 * 3) This Wiki and other sources for user manuals, tutorials etc. (This type of documentation being supplied primarily to end users.)

Javadoc
If developers use the recommended development environment setup then the JAutodocs plugin can be used to create correct template Javadocs. This approach ensures consistency in Javadoc production and minimises the amount of work demanded of developers.

The project will follow the Sun Javadoc style guidelines.