2008/11/05

Coding Rule...


1. “if”,”for”,”while”,”switch”…等一定要有{},就算裡面只有一行程式。”{“左括號接在判斷式後面不要獨立一行,”}”右括號要獨立一行且與判斷式一同縮行。Ex.
If (a > b) {
….
}
else {
….
}

2. 用tab縮行,不要用space。

3. switch與case放在同一層,每個case要有 break,要fall through要加注解,switch要有default,ex.
switch (condition) {
case CONDITION_ONE:
…..
break;
default:
break;
}

4. break, continue, goto要小心使用。

5. 不要用magic number,ex.
使用
#define RESULT_OP_NORMAL 1
….
return RESULT_OP_NORMAL;
取代
Return 1;

6. 有時間請多加註解,加註解請不要解釋每一行在做什麼,最好是針對一整個block來做註解,最好每個function都有註解說明此function在做什麼,輸入變數及輸出的數值的意義。Global variable如果能加上註解更好。

沒有留言:

張貼留言