CODING STANDARD

Version: 0.01

CODING STANDARD CHECKLIST Type No 1 Class

Detail

Note

t tn class theo qui tc ch ci u mi t vit hoa. VD: SampleName t tn class kiu activity: qui tc tng t t tn class. Kt thc bng Activity VD: SampleActivity t tn class Exception: qui tc tng t t tn class. Kt thc bng Exception VD: ClassNameEndsWithException t tn Interface: qui tc tng t t tn class. Bt u bi ch

Class

Class

4 Interface I VD: ISampleName t tn method bt u l ch thng, ch u ca t k tip vit hoa. T u ca method phi l ng t. (Khng dng "do", "does"). Tn parameter bt u l ch thng, ch u ca t 5 Method k tip vit hoa. VD: loadSomeThingByIndex(int index) i vi method tr v kiu boolean theo qui tc sau: is + adjective, can + verb, has + past participle, verb nguyn mu ngi ba, verb nguyn mu ngi ba+ Noun Tham kho ph lc No1. i vi method c nhiu param, th nn gi cng nh khai bo cch dng, cc param th phi thng hng vi nhau t dng th 2 tr i. Vd: Tham kho ph lc No2. Khng c s dng overload method m ch c khc nhau dng tham s C th s dng cho method c s lung tham s khc nhau Tham kho ph lc No9.

Method

Method

Method

Tn constant tt c phi vit hoa, gia cc t cch nhau bi "_". 9 Constant Bt u bng prefix CONST_ VD: public static final int CONST_ALL_CAPS = 42; Khi khai bo try catch, phi catch ng Exception s pht sinh, khng catch Exception common. Trong phn x l catch, khng 10 Exception c trng Tham kho ph lc No3

http://www.greensun.com.vn

11 Exception Khng c khai bo try catch trong cc vng lp i vi nhng t chuyn dng, khng c vit hoa. M phi coi 12 Variable l 1 t thng thng (p dng cho c method, v class) Tham kho ph lc No10 i vi cc bin thuc cp class th: Cc bin khng phi l bin public, khng phi l static th phi 13 Variable bt u bng ch "m" Tuyt i khng s dng bin static Tham kho ph lc No4 14 Variable Lun check null object trc khi s dng trnh chng trnh b crash thi im thc thi. Khng s dng bin kiu public, m phi s dng set/get method khi mun ly, hoc thit nh gi tr cho bin

15

Variable

16 Database Sau khi thao tc xong database phi thc hin ng kt ni Comment theo javadoc Tham kho ph lc No.6, No.7, No.8

17 Comment

18 Comment Khng comment out code khng s dng m hy xa i S dng TODO//TODO: ni dung cn phi lm, ghi ch 19 Comment cc vic cn lm, khng s dng comment thng thng ghi ch 20 21 22 Other Other Other Mt dng khng di qu 100 k t. Khng s dng tab trong code, m thay vo dng k t khong trng. 1tab = 4 khong trng. (thit nh trong Eclipse) S dng m v ng {, } phi theo chun ph lc No 5 Khai bo array String[] args; --- OK String args[]; --- NG

23

Other

24 Package Ch c tn package name bng ch thng

25

Other

Khi build project khng c warnings/errors.

26

Other

Khng t tn vit tt, tt nht l vit ting Anh c t.

http://www.greensun.com.vn

27

Other

Khng vit li cc on code x l ging nhau, m phi s dng hm chung Khng vit lng cc vng lp t 3 cp tr ln (Nu logic bt buc th, t vng lp th 3, th c th thay bng 1hm ring) Khng vit lng cc on if t 3 cp tr ln (Nu logic bt buc th, t If th 3, th c th thay bng 1hm ring)

28

Other

29

Other

30

Other

Khng c commentout m phi xa cc on code khng dng n

31

Other

Khng qu nhiu dng trng v ch (t 3, 4 dng)

32

Other

i vi lp hoc hm b deprecated th phi dng lp hoc hm thay th khc. ngy Ngi kim tra thng nm

Ngi thc hin

Ph lc No VD: boolean isEmpty() VD: boolean canGet() VD: boolean hasChanged() 1 VD: boolean contains(Object)

Detail

Note

VD: boolean containsKey(Key) VD: boolean exists() colorWithValue(int alibratedHue, int saturation, 2 int brightness, int alpha) { try { someComplicatedIOFunction(); // s throw IOException someComplicatedParsingFunction(); // throw ParsingException someComplicatedSecurityFunction(); // throw 3 SecurityException } catch (Exception e) { // <---- NG // <----- NG: phi x l expception }

http://www.greensun.com.vn

public class MyClass { public int someField; int mPackagePrivate; 4 scope private int mPrivate; protected int mProtected; } class MyClass { int func() { if (something) { // ... } else if (somethingElse) { 5 // ... } else { // ... } } } Comment ca java c 3 loi /** ... */ comment ca javadoc. c xut ra theo dng html comment thng thng, mang tnh ni b 6 /* */ // comment thng thng, mang tnh ni b Bt buc gn comment /** */ vo field, method, class public Comment class /** * Does X and Y and provides an abstraction for Z. 7 */ public class Foo { ... } Comment method, s dng Eclipse gen ra comment javadoc cho method. Phi in y thng tin param, return, exception @param paramName description 8 @return description of return value @exception exceptionName description NG : draw(Line), draw(Rectangle) 9 OK : draw(Line), draw(Line, Length) OK : drawLine(Line), drawRectangle(Rectangle) XmlHttpRequest <-- OK XMLHTTPRequest <--- NG 10 getCustomerId <---- OK getCustomerID <---- NG <--- NG: hn ch khai bo ko r

http://www.greensun.com.vn

http://www.greensun.com.vn