summaryrefslogtreecommitdiff
path: root/doc/Coding_style
blob: df5e398c960980e498d5ac8b15907e05f107b12a (plain)
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
46
47
48
49
50
51
The coding style is almost the same as i blackbox.
Instead of 2 spaces there is tab.
It might look strange now in some places, that is because
the code hasnt been "translated" to tab 100% yet.
Use a tab size of 2 and you will be fine.

if-statements:

	if ( stuff ) 
		function(stuff, more stuff, 
			more, even more);
	else
		morefunction( stuff, more stuff
			stuff, 
			stuff,
			stuff);
			
if the functionline needs to be split up, like above, right after an if-statement
use { and }, so its clear when the if-statement ends.
It should look like this

	if ( stuff ) {
		function(stuff, more stuff, 
			more, even more);
	} else {
		morefunction( stuff, more stuff
			stuff, 
			stuff,
			stuff);
	}
	

The include guards:
_FILENAME_HH_ 


Function comments:
//------------ function name --------
// This do that and that
// Returns this on success else
// this on failure.
// TODO: if there is something to do.
//-----------------------------------
type classname::function(...) {

}


enums must be in uppercase letters:
enum {WHITE, RED, BLUE};