OpenCodes/coding_style.txt at master · Yottabits/OpenCodes · GitHub

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
56
57
58
59
60
61
#File Names
small only
use underscores "_" if needed
exception: GIThub files - LICENSE und README.md
Folders follow the same rules

#files
max 200lines if possible

#tabs
8 spaces represent one tab (Atom Settings at the very bottom)

#Function and Method Names
camelCase()
first letter small next Word big

#Variable Names
*talking* names,  Only one Sense
Iterators are fine as i or j
for Complex Numbers use j as imaginary part :)
UpperCamelCase
first Letter Big next Word big

#Constants
CAPS

#brackets
if(Condition){
        one Indent!
}elseif(Condition){
        aea
}else{

}
for(){
        #naetnd
}
while(){
        #ane
}

#Comments
Use as less as possible - use understandable Code instead
Use Block Comments only for testing, not in final Code

#general
        - Use English only
        - Do not use Switch Case Statements
        - Use talking Variables instead of long Conditions
        - design according to Material Design Rules if possible
        - Use only funny Errors-Messages! like "Error: Dome is an Idiot"

#Language Focused

        #SQL

        #HTML

        #CSS

        #PHP