COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/coding_style.dox @ 921:818510fa3d99

Last change on this file since 921:818510fa3d99 was 921:818510fa3d99, checked in by Alpar Juttner, 15 years ago

hugo -> lemon

File size: 1.5 KB
Line 
1/*!
2
3\page coding_style LEMON Coding Style
4
5\section naming_conv Naming Conventions
6
7In order to make development easier we have made some conventions
8according to coding style. These include names of types, classes,
9functions, variables, constants and exceptions. If these conventions
10are met in one's code then it is easier to read and maintain
11it. Please comply with these conventions if you want to contribute
12developing LEMON library.
13
14\subsection cs-class Classes and other types
15
16The name of a class or any type should look like the following:
17
18\code
19AllWordsCapitalizedWithoutUnderscores
20\endcode
21
22\subsection cs-func Methods and other functions
23
24The name of a function should look like the following:
25
26\code
27firstWordLowerCaseRestCapitalizedWithoutUnderscores
28\endcode
29
30\subsection cs-funcs Constants, Macros
31
32The names of constants and macros should look like the following:
33
34\code
35ALL_UPPER_CASE_WITH_UNDERSCORES
36\endcode
37
38\subsection cs-loc-var Class and instance member variables, auto variables
39
40The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
41
42\code
43all_lower_case_with_underscores
44\endcode
45
46\subsection cs-excep Exceptions
47
48When writing exceptions please comply the following naming conventions:
49
50\code
51ClassNameEndsWithException
52\endcode
53
54\warning In some cases we diverge from these rules.
55This primary done because STL uses different naming convention and
56in certain cases
57it is beneficial to provide STL compatible interface.
58
59*/
Note: See TracBrowser for help on using the repository browser.