COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/coding_style.dox @ 614:75cf1d52eee5

Last change on this file since 614:75cf1d52eee5 was 614:75cf1d52eee5, checked in by Alpar Juttner, 15 years ago

Minor changes: Section labels fixed.

File size: 1.3 KB
Line 
1/*!
2
3\page coding_style Hugo Coding Style
4
5\section Naming Conventions
6
7In 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.
8
9\subsection cs-class Classes and other types
10
11The name of a class or any type should look like the following:
12
13\code
14AllWordsCapitalizedWithoutUnderscores
15\endcode
16
17\subsection cs-func Methods and other functions
18
19The name of a function should look like the following:
20
21\code
22firstWordLowerCaseRestCapitalizedWithoutUnderscores
23\endcode
24
25\subsection cs-funcs Constants, Macros
26
27The names of constants and macros should look like the following:
28
29\code
30ALL_UPPER_CASE_WITH_UNDERSCORES
31\endcode
32
33\subsection cs-loc-var Class and instance member variables, auto variables
34
35The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
36
37\code
38all_lower_case_with_underscores
39\endcode
40
41\subsection cs-excep Exceptions
42
43When writing exceptions please comply the following naming conventions:
44
45\code
46ClassNameEndsWithException
47\endcode
48
49
50*/
Note: See TracBrowser for help on using the repository browser.