COIN-OR::LEMON - Graph Library

source: lemon-1.0/doc/coding_style.dox @ 152:b37cc0bb12db

Last change on this file since 152:b37cc0bb12db was 41:b11737922197, checked in by Alpar Juttner <alpar@…>, 12 years ago

Minor updates in the doc

File size: 2.9 KB
Line 
1/* -*- C++ -*-
2 *
3 * This file is a part of LEMON, a generic C++ optimization library
4 *
5 * Copyright (C) 2003-2008
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 *
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
12 *
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
15 * purpose.
16 *
17 */
18
19/*!
20
21\page coding_style LEMON Coding Style
22
23\section naming_conv Naming Conventions
24
25In order to make development easier we have made some conventions
26according to coding style. These include names of types, classes,
27functions, variables, constants and exceptions. If these conventions
28are met in one's code then it is easier to read and maintain
29it. Please comply with these conventions if you want to contribute
30developing LEMON library.
31
32\note When the coding style requires the capitalization of an abbreviation,
33only the first letter should be upper case.
34
35\code
36XmlReader
37\endcode
38
39
40\warning In some cases we diverge from these rules.
41This is primary done because STL uses different naming convention and
42in certain cases
43it is beneficial to provide STL compatible interface.
44
45\subsection cs-files File Names
46
47The header file names should look like the following.
48
49\code
50header_file.h
51\endcode
52
53Note that all standard LEMON headers are located in the \c lemon subdirectory,
54so you should include them from C++ source like this:
55
56\code
57#include <lemon/header_file.h>
58\endcode
59
60The source code files use the same style and they have '.cc' extension.
61
62\code
63source_code.cc
64\endcode
65
66\subsection cs-class Classes and other types
67
68The name of a class or any type should look like the following.
69
70\code
71AllWordsCapitalizedWithoutUnderscores
72\endcode
73
74\subsection cs-func Methods and other functions
75
76The name of a function should look like the following.
77
78\code
79firstWordLowerCaseRestCapitalizedWithoutUnderscores
80\endcode
81
82\subsection cs-funcs Constants, Macros
83
84The names of constants and macros should look like the following.
85
86\code
87ALL_UPPER_CASE_WITH_UNDERSCORES
88\endcode
89
90\subsection cs-loc-var Class and instance member variables, auto variables
91
92The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following.
93
94\code
95all_lower_case_with_underscores
96\endcode
97
98\subsection pri-loc-var Private member variables
99
100Private member variables should start with underscore
101
102\code
103_start_with_underscores
104\endcode
105
106\subsection cs-excep Exceptions
107
108When writing exceptions please comply the following naming conventions.
109
110\code
111ClassNameEndsWithException
112\endcode
113
114or
115
116\code
117ClassNameEndsWithError
118\endcode
119
120\section header-template Template Header File
121
122Each LEMON header file should look like this:
123
124\include template.h
125
126*/
Note: See TracBrowser for help on using the repository browser.