Coding Standards

Table of Contents

• Indentation
• Classes and Namespaces
• Variables and Functions
• Constants

Indentation

Use an indent of 4 spaces, with no tabs.
This helps to avoid problems with diffs, patches, CVS history and annotations.

Classes and Namespaces

Classes should be named using the camel case style with the exception of the first character which should be uppercase.

Namespaces are always lowercase.

Variables and Functions

Variables and functions should be named using the camel case style.

Constants

Constants should always be all-uppercase, with underscores to separate words.
In most cases, it's advised to use a prefix to indicate what kind of constant it is (eg. PARAM_XXX)

NOTE: Use meaningfull names. Sometimes it's better to use a longer, meaningful name, then a shorter meaningless name.