2008/11/04

Naming Rule...

取名以清楚明瞭為原則
最好是看了就能明白變數的意義
不要因為要簡化而無法清楚明白變數的意義。

1. Directory name
小寫英文開頭
以大寫字母斷字
ex. eponOnuConf

2. File name
全小寫英文字母
最好與directory name相同
如果要把每個tab的function獨立成一個檔案用tab_[tab名].C。
ex. epononuconf.xd、tab_8021x.C

3. Global variable name
小寫英文開頭以大寫字母斷字
ex. int thisPtr

4. Local variable name
全小寫以底線斷字
ex. int tmp_profile_name

5. Structure name
Structure name大寫英文開頭以大寫字母斷字
structure member小寫英文開頭大寫英文斷字
ex.
typedef struct {
  int one;
  int twoAndThree;
} MyStruct;

6. Procedure name
以小寫開頭大寫斷字
ex. void getProfileName()

沒有留言:

張貼留言