forked from gansm/finalcut
-
Notifications
You must be signed in to change notification settings - Fork 0
/
coding-style.txt
47 lines (39 loc) · 1.21 KB
/
coding-style.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
============
Coding style
============
Formatting
----------
* A new line should begin after 72 (max. 80) characters
* Use 2 spaces indent. Do not use tabs!
* Leave a space after the keywords if, switch, while, do, for, and return
* Conditions are placed in parentheses with spaces -> if ( a > 5 )
* Use one blank line before and after a for, if, switch,
while, do..while code block
* In parameter lists, leave a space after each comma
* Starting curly brace "{" in a new line
Naming
------
* class name: UpperCamelCase
* Function: lowerCamelCase
* Callback function: cb_lowerCamelCase (beginning with "cb_" as prefix)
* Variable: lower_case_underscored
Class declaration order
-----------------------
The declaration section order is:
* public:
* protected:
* private:
Each declaration section should be in the following order:
* Using-declarations (using std::string;)
* Typedefs and Enumerations
* Constants (static const data members)
* Constructors
* Destructor
* Overloaded operators (=, +, -, +=. ...)
* Accessors (getXY)
* Mutators (setXY)
* Inquiries (isXY)
* Methods, including static methods
* Event handler methods
* Callback methods
* Data Members (except static const data members)