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 static 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, do the following:
cd nox/doc
doxygen 

Generated on Thu Sep 18 12:40:41 2008 for NOX by doxygen 1.3.9.1