LEMON Coding Style

Naming Conventions

In order to make development easier we have made some conventions according to coding style. These include names of types, classes, functions, variables, constants and exceptions. If these conventions are met in one's code then it is easier to read and maintain it. Please comply with these conventions if you want to contribute developing LEMON library.

Classes and other types

The name of a class or any type should look like the following:

AllWordsCapitalizedWithoutUnderscores 

Methods and other functions

The name of a function should look like the following:

firstWordLowerCaseRestCapitalizedWithoutUnderscores 

Constants, Macros

The names of constants and macros should look like the following:

ALL_UPPER_CASE_WITH_UNDERSCORES 

Class and instance member variables, auto variables

The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:

all_lower_case_with_underscores 

Exceptions

When writing exceptions please comply the following naming conventions:

ClassNameEndsWithException

Warning:
In some cases we diverge from these rules. This primary done because STL uses different naming convention and in certain cases it is beneficial to provide STL compatible interface.

Generated on Thu Sep 30 12:18:36 2004 for LEMON by doxygen 1.3.8