代碼命名方式

幾種常見的程序命名規則
正確並形象地給函數、變量命名,不僅可以增加程序的可讀性,也是程序員編程風格的一種反映。較好的命名習慣,可以有效的提高程序的可維護性。以下介紹幾種常用的變量命名規則。
一、匈牙利命名法:廣泛應用於Microsoft Windows這類環境中。
這種命名技術是由一位能幹的 Microsoft 程序員查爾斯·西蒙尼(Charles Simonyi) 提出的。匈牙利命名法通過在變量名前面加上相應的小寫字母的符號標識作爲前綴,標識出變量的作用域,類型等。這些符號可以多個同時使用,順序是先m_(成 員變 量),再指針,再簡單數據類型,再其他。例如:m_lpszStr, 表示指向一個以0字符結尾的字符串的長指針成員變量。
匈牙利命名法關鍵是:標識符的名字以一個或者多個小寫字母開頭作爲前綴;前綴之後的是首字母大寫的一個單詞或多個單詞組合,該單詞要指明變量的用途。
例如:bEnable, nLength, hWnd。
匈牙利命名法中常用的小寫字母的前綴:

屬性部分:
g_ 全局變量
c_  常量
m_  c++類成員變量
s_  靜態變量
類型部分:
數組 a
指針 p
函數 fn
無效 v
句柄 h
長整型 l
布爾 b
浮點型(有時也指文件) f
雙字  dw
字符串  sz
短整型  n
雙精度浮點 d
計數 c(通常用cnt)
字符 ch(通常用c)
整型 i(通常用n)
字節 by
字 w
實型 r
無符號 u
描述部分:
最大 Max
最小 Min
初始化 Init
臨時變量 T(或Temp)
源對象 Src
目的對象 Dest

二、駝峯命名法:近年來越來越流行。
駝峯命名法,正如它的名稱所表示的那樣,指的是混合使用大小寫字母來構成標識符的名字。其中第一個單詞首字母小寫,餘下的單詞首字母大寫。
例如:

printEmployeePaychecks(); 

函數名中每一個邏輯斷點都有一個大寫字母來標記。

三、帕斯卡(Pascal)命名法:與駝峯命名法類似。
只不過駝峯命名法是第一個單詞首字母小寫,而帕斯卡命名法則是第一個單詞首字母大寫。因此這種命名法也有人稱之爲“大駝峯命名法”。
例如:

DisplayInfo(); 
UserName 

都是採用了帕斯卡命名法。
在C#中,以帕斯卡命名法和駱駝命名法居多。
事實上,很多程序設計者在實際命名時會將駝峯命名法和帕斯卡結合使用,例如變量名採用駝峯命名法,而函數採用帕斯卡命名法。

四、下劃線命名法。
下劃線法是隨着C語言的出現流行起來的,在UNIX/LIUNX這樣的環境,以及GNU代碼中使用非常普遍。
4.1 函數的命名
函數名使用下劃線分割小寫字母的方式命名:
設備名_操作名();

操作名一般採用:謂語(此時設備名作爲賓語或者標明操作所屬的模塊)或者謂語 賓語/表語(此時設備名作爲主語或者標明操作所屬的模塊) 等形式,如:

tic_init(); 
adc_is_busy(); 
uart_tx_char();

中斷函數的命名直接使用 設備名_isr() 的形式命名,如:

timer2_isr();

4.2 變量的命名
變量的命名也採用下劃線分割小寫字母的方式命名。命名應當準確,不引起歧義,且長度適中。如:

int length; 
uint32 test_offset;

單字符的名字也是常用的,如i, j, k等,它們通常可用作函數內的局部變量。tmp常用做臨時變量名。
局部靜態變量,應加s_詞冠(表示static),如:

static int s_lastw;

全局變量(尤其是供外部訪問的全局變量),應加g_詞冠(表示global),如:

void (* g_capture_hook)(void);

4.3 常量及宏的命名
採用下劃線分割大寫字母的方式命名,一般應以設備名作爲前綴,
防止模塊間命名的重複。如:

#define TIMER0_MODE_RELOAD 2
#define TIMER2_COUNT_RETRIEVE(val) ((uint16)(65536 - (val)))

當然,看作接口的宏可以按照函數的命名方法命名,例如:

#define timer2_clear() (TF2 = 0)
#define timer0_is_expired() (TF0)

據考察,沒有一種命名規則可以讓所有的程序員贊同,程序設計教科書一般都不指定命名規則。命名規則對軟件產品而言並不是“成敗悠關”的事,我們不要化太多精力試圖發明世界上最好的命名規則,而應當制定一種令大多數項目成員滿意的命名規則,並在項目中貫徹實施。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章