added phonies to make, added fps to debug
[physics.git] / src / codingstyle.txt
CommitLineData
ad9f1fb6
PG
1These are a few style guidelines of my own that I try to adhere to.
2This 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 two newlines before star lines, excluding the first
22
23/// ***** Private Method Headers *****
24/// ***** Private Variables *****
25
26/// ***** Constructors/Destructors *****
27
28/// ***** Public Methods *****
29/// ***** Private Methods *****
30
31/// ***** Public Class Methods *****
32/// ***** Protected Class Methods *****
33/// ***** Private Class Methods *****
34
35
36/// ***** Header Class *****
37/// ***** Header Methods *****