-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSTYLE_GUIDE
38 lines (25 loc) · 1.01 KB
/
STYLE_GUIDE
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
[Coding Style]
With the exception of indentation, follow the code style described at:
http://code.google.com/webtoolkit/makinggwtbetter.html
In particular, note the "Class Structure and Member Sort Order", "Imports", and "Acronyms in names" sections.
For indentation, use 4-space indents for blocks (NO tabs) (also use 4-spaces after line wraps).
For if/else stmts:
if (cond) {
;
} else {
;
}
[Javadoc]
Include javadoc tags in the following order:
@author (classes and interfaces only, required)
@version (classes and interfaces only, required. See footnote 1)
@param (methods and constructors only)
@return (methods only)
@exception (@throws is a synonym added in Javadoc 1.2)
@see
@since
@serial (or @serialField or @serialData)
@deprecated (see How and When To Deprecate APIs)
Multiple @author tags should be listed in chronological order, with the creator of the class listed at the top.
For more info, see:
http://java.sun.com/j2se/javadoc/writingdoccomments/