-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathConventions.txt
30 lines (21 loc) · 980 Bytes
/
Conventions.txt
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
Conventions
Class Naming:
Capital letter for each word's start in class. Letters after the first letter in any abbreviations will be lowercase (i.e. SCUBA would be named Scuba)
Method Naming:
Capital letter for each word's start in method. Same convention as class naming
Variable Naming:
First letter of first word in variable name is lowercase. All subsequent words are uppercase. (i.e. texasHoldEm)
Commenting:
In line comments are acceptable. Block comments above methods to describe their purpose. Block comments
will be in line with the blocks, not indented.
Indents:
Tabs on each indent
Brackets:
Opening bracket below method declaration
Lines:
Lines should not be over 140 lines
Whitespace:
Use appropriate whitespace as needed
Methods:
Methods used more than twice shall be combined and placed into a class reachable to classes that need its access
Common/re-used/repeated chunks of code shall be combined as to avoid having reused