NOX Developer's Coding Guidelines

Adapted largely from Programming in C++, Rules and Recommendations, by Mats Henricson and Erik Nyquist.

Structure of the Files

Naming Conventions
General File Structure
Include File Structure

Naming Conventions

Style

Classes
Functions
Variable declarations
Loops and conditionals: if, for, while, etc.
Miscellaneous

Coding Rules

Output

The NOX::Utils class has utility functions related to printing. To use it, include NOX_Utils.H.

Error Handling

Comments

We use Doxygen for the comments. To generate the documentation. Instructions can be found in the README file in the top-level nox directory.
Generated on Wed May 12 21:41:53 2010 for NOX by  doxygen 1.4.7