source: lemon-0.x/doc/coding_style.dox @ 811:e27135322727

/*!

\page coding_style Hugo Coding Style 

\section naming_conv 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 Hugo library.

\subsection cs-class Classes and other types

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

\code
AllWordsCapitalizedWithoutUnderscores 
\endcode

\subsection cs-func Methods and other functions

The name of a function should look like the following:

\code
firstWordLowerCaseRestCapitalizedWithoutUnderscores 
\endcode

\subsection cs-funcs Constants, Macros

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

\code
ALL_UPPER_CASE_WITH_UNDERSCORES 
\endcode

\subsection cs-loc-var 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:

\code
all_lower_case_with_underscores 
\endcode

\subsection cs-excep Exceptions

When writing exceptions please comply the following naming conventions:

\code
ClassNameEndsWithException
\endcode

\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.

*/