summaryrefslogtreecommitdiff
path: root/CodingStyle
blob: c5d730c0a6a5433715a02d6481aeaf9204688840 (about) (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
52
53
54
55
CODING STANDARDS:

Functions and methods do not return errorcodes, but use assert for
checking status. 

INDENTATION, in emacs:


(add-hook 'c-mode-hook
	  '(lambda ()(setq c-basic-offset 4)))


(add-hook 'c++-mode-hook
	  '(lambda() (c-set-style "Stroustrup")
	     )
	  )


CLASSES and TYPES:

	This_is_a_class

DATA MEMBERS

	Class:member

if the member's name resembles its type, then we use

	Class Fubular { ..}

	Class::fubular_

COMMENTS

/// short description
class Class {
	///
	Data data_member_;
	/**
		..
	*/

	/****************/

	/// short memo
	member();
	/**
		long doco of member()
	*/
};
/**
	Class documentation.
*/

Unfortunately most of the code isn't really documented that good.