COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/coding_style.dox @ 613:b5b5c4ae5107

Last change on this file since 613:b5b5c4ae5107 was 603:86458ad390a7, checked in by athos, 16 years ago

I completed the description of the coding style.

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