Coding Standards

From MantidProject

Jump to: navigation, search

Coding Standards

Coding standards are vital for creating a maintainable and extensible system. However in order for them to be effective they have to be accepted and supported by the entire development team.

Code produced by code generators is not covered directly by this procedure. Programmers must apply the underlying principles of this procedure in a sensible manner to code generated automatically.

Conventions

Mandatory sections in this document are denoted by (M). Recommended sections are denoted by (R). Sub-sections where the necessity is not explicitly stated take the necessity of the section above. Developers may decide not to follow a ‘recommend’ section, but must be prepared to justify their decision in a code review.

Specific Coding Standards

Personal tools
Create a book