Skip to content
Browse files

issue #426 Description of the coding style

Issue #426 Description of the coding style
  • Loading branch information...
1 parent b9e14f6 commit dc3d4d4b7c3a0f6f9c8b576530e2cc14db4117f6 Arjan Wulder committed Sep 8, 2012
Showing with 139 additions and 0 deletions.
  1. +139 −0 CODING_STYLE.md
View
139 CODING_STYLE.md
@@ -0,0 +1,139 @@
+# Coding style
+
+
+## Tabs and Indents
+
+* Tab size : 4
+* Indent : 4
+* Continuation indent : 8
+* Label indent : 0
+
+> Don't use tab characters.
+
+## Spaces
+
+### Before Parentheses
+* ```if``` parentheses
+* ```for``` parentheses
+* ```while``` parentheses
+* ```switch``` parentheses
+* ```try``` parentheses
+* ```catch``` parentheses
+* ```synchronized``` parentheses
+
+### Around Operators
+* Assignment operators (```=```, ```+=```, …)
+* Logical operators (```&&```, ```||```)
+* Equality operators (```==```, ```!=```)
+* Relational operators (```<```, ```>```, ```<=```, ```>=```)
+* Bitwise operators (```&```, ```|```, ```^```)
+* Additive operators (```+```, ```-```)
+* Multiplicative operators (```*```, ```/```, ```%```)
+* Shift operators (```<<```, ```>>```, ```>>>```)
+
+### Before Left Brace
+* Class left brace
+* Method left brace
+* ```if``` left brace
+* ```else``` left brace
+* ```for``` left brace
+* ```while``` left brace
+* ```do``` left brace
+* ```switch``` left brace
+* ```try``` left brace
+* ```catch``` left brace
+* ```finally``` left brace
+* ```synchronized``` left brace
+
+### Before Keywords
+* ```else``` keyword
+* ```while``` keyword
+* ```catch``` keyword
+* ```finally``` keyword
+
+### In Ternary Operator (?:)
+* Before ```?```
+* After ```?```
+* Before ```:```
+* After ```:```
+
+### Within Type Arguments
+* After comma
+
+### Other
+* After comma
+* After semicolon
+* After type cast
+
+## Wrapping and Braces
+
+### Braces placement
+* In class declaration : End of line
+* In method declaration : End of line
+* Other : End of line
+
+### Use Of Braces
+* ```if()``` statement : When multiline
+* ```for()``` statement : When multiline
+* ```while()``` statement : When multiline
+* ```do .. while()``` statement : When multiline
+
+### Annotations
+* Class annotations : Wrap always
+* Method annotations : Wrap always
+* Field annotations : Wrap always
+* Paramater annotations : Do not wrap
+* Local variable annotations : Do not wrap
+
+## Blank Lines
+
+### Keep Maximum Blank Lines
+* In declarations : 2
+* In code : 2
+* Before ```}``` : 2
+
+### Minimum Blank Lines
+* Before package statement : 0
+* After package statement : 1
+* Before imports : 1
+* After imports : 1
+* Around class : 1
+* After class header : 0
+* After anonymous class header : 0
+* Around field in interface : 0
+* Around field : 0
+* Around method in interface : 1
+* Around method : 1
+* Before method body : 0
+
+## JavaDoc
+
+### Alignment
+
+* Align parameter descriptions
+* Align thrown exception descriptions
+
+### Blank Lines
+
+* After description
+
+### Invalid tags
+* Keep empty ```@param``` tags
+* Keep empty ```@return``` tags
+* Keep empty ```@throws``` tags
+
+### Other
+* Enable leading asterisks
+* Use ```@throws``` rather then ```@exception```
+* Keep empty lines
+
+## Imports
+
+### Import layout
+__import static__ all other imports
+_blank line_
+__import__ javax.*
+__import__ java.*
+__import__ com.*
+_blank line_
+__import__ all other imports

0 comments on commit dc3d4d4

Please sign in to comment.
Something went wrong with that request. Please try again.