keys setup to use extern
[physics.git] / codingstyle.txt
1 These are a few style guidelines of my own that I try to adhere to.
2 This is in a very short form as it's mostly for myself.
3
4 - FileNameWithClass
5 - ClassName
6   - Public_Class_Variable
7   - protected_Class_Variable
8   - private_Class_Variable
9
10 - fileNameWithMethods
11   - variable_Local_To_File
12 - methodName, class or file
13   - method_parameter
14   - method_variable
15
16 - prefix consts with c, camel -> cName, under -> c_Name
17
18
19 - sections of a file should be commented with the following where appropriate
20   - they should appear in this order
21   - they should have a newline above and below star lines
22
23 Headers:
24 /// ***** Header Class *****
25 /// ***** Header Methods *****
26
27 Source:
28 /// ***** Private Method Headers *****
29 /// ***** Private Variables *****
30
31 /// ***** MAIN Method *****
32
33 /// ***** Constructors/Destructors *****
34 /// ***** Initializers/Cleaners *****
35
36 /// ***** Public Class Methods *****
37 /// ***** Protected Class Methods *****
38 /// ***** Private Class Methods *****
39
40 /// ***** Public Methods *****
41 /// ***** Private Methods *****