C++編程命名規(guī)范

1、在軟件開發(fā)過程中，代碼的命名規(guī)范是一項很突出的內(nèi)容。一套定義完整、結(jié)構(gòu)清晰明了的命名規(guī)范將大大提升源代碼的可讀性和軟件的可維護性。據(jù)考證，沒有一種命名規(guī)則可以讓所有的程序員都滿意，程序設(shè)計教科書一般也不會指定命名規(guī)則。但是制定一套令開發(fā)組成員基本滿意的命名規(guī)則，并在項目中貫徹實施，也是團隊開發(fā)一項必不可少的工作。我將我的團隊的實際工作中的命名規(guī)則整理如下：第一部分：共性規(guī)則共有八項。作為指導(dǎo)供成員采納。【規(guī)則1】標識符應(yīng)簡單明了，望文知意。標識符采用英文單詞。切忌使用漢語拼音來命名。程序中的英文單詞一般不要太復(fù)雜，用詞應(yīng)當(dāng)準確。例如不要把CurrentValue寫成NowValue。盡量不要使

2、用單詞縮寫或首字母縮寫。只有當(dāng)標識符過長時才考慮使用單詞縮寫。在使用縮寫時，不要自創(chuàng)縮寫，盡量使用被廣泛接受的縮寫。【規(guī)則2】標識符長度應(yīng)當(dāng)符合“min-length&max-information”原則。一般的講，長名字能更好地表達含義，所以函數(shù)名、變量名、類名長達十幾個字符不足為怪。但是名字也不是越長越好。例如：變量名maxval就比maxValueUntilOverflow更好用。單字符的名字也是有用的，常見的如i,j,k,m,n,x,y,z等，它們通常用作函數(shù)內(nèi)的局部變量。【規(guī)則3】命名規(guī)則盡量與所采用的操作系統(tǒng)或開發(fā)工具的風(fēng)格保持一致。例如Windows應(yīng)用程序的標識符通常采用“大小

3、寫”混排的方式，如AddChild。而Unix應(yīng)用程序的標識符通常采用“小寫加下劃線”的方式，如add_child。別把這兩類風(fēng)格混在一起用?！疽?guī)則4】程序中不要出現(xiàn)僅靠大小寫區(qū)分的標識符。例如：intx和intX；voidfoo()和voidFOO()等?！疽?guī)則5】避免在不同級別的作用域中重名。程序中不要出現(xiàn)標識符完全相同的局部變量和全局變量，盡管兩者因作用域的不同而不會發(fā)生語法錯誤，但會使人產(chǎn)生誤解?！疽?guī)則6】正確命名具有互斥意義的標識符。使用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)。如：MinValue和MaxValue,GetName()和SetName()【規(guī)則7】盡量避

4、免名字中出現(xiàn)數(shù)字編號。如Value1,Value2等，除非邏輯上的確需要編號。這是為了防止程序產(chǎn)生無意義的名字，降低程序的可讀性?！疽?guī)則8】使用庫標志在開發(fā)動態(tài)庫時，為了防止軟件庫中的一些標識符和其它軟件庫中標識符沖突，可以為各種標識符加上能反映軟件性質(zhì)的前綴。例如三維圖形標準OpenGL的所有庫函數(shù)均以gl開頭，所有常量（或宏定義）均以GL開頭。第二部分：細則我采用了一部分的“匈牙利”法命名規(guī)范，但沒有照搬。“匈牙利”法最大的特征就是類型前綴。例如：intnNum=0;/n為類型信息，表明nNum是一個int類型classCUser;/C為類型信息，表明CUser是一個類但是正因為如此，“匈

5、牙利”法命名規(guī)范也給人一種繁瑣的感覺。例如：inti,j,k;floatx,y,z;倘若采用“匈牙利”命名規(guī)則，則應(yīng)當(dāng)寫成：intiI,iJ,ik;/前綴i表示int類型floatfX,fY,fZ;/前綴f表示float類型對于此類情況，我的處理方式是不加類型前綴。而對于下列情況我會加：intiHeigh;BoolbFlag;總之，在我的命名規(guī)范中，類型前綴是一個可選的命名規(guī)則。下面分類進行詳細的規(guī)范。一、類和接口1、命名：類名都以大寫字母“C開頭，后跟一個或多個單詞。每個單詞的首字母要大寫。接口以大寫I開頭，代表Interface。2、組成形式：推薦用名詞或形容詞名詞的形式，例如：CAnal

6、yzer,CFastVector二、函數(shù)1、命名：函數(shù)的名稱由一個或多個單詞組成。每個單詞的首字母要大寫。最長不得超過20個字符。2、組成形式：全局函數(shù)應(yīng)當(dāng)使用動詞或者動詞名詞(動賓詞組)的形式。例如:gGetName(),gDrawBox()。類成員函數(shù)應(yīng)當(dāng)只使用“動詞”，被省略掉的名詞就是對象本身例如:box-Draw();。3、全局函數(shù)：以小寫前綴g開頭。4、保護成員函數(shù):開頭應(yīng)當(dāng)加上一個下劃線“_”以示區(qū)別，例如：_SetState()5、私有成員函數(shù)：開頭應(yīng)當(dāng)加上兩個下劃線“_”，例如：_DestroyImp()6、虛函數(shù)：習(xí)慣以“Do開頭，如：DoRefreshO,_DoEncry

7、ption()7、回調(diào)和事件處理函數(shù)：習(xí)慣以單詞“On開頭。例如：_OnTimer(),OnExit()三、變量變量是程序中使用最多的標識符，變量的命名規(guī)范是一套C+命名規(guī)范中最重要的部分：1、命名：變量名由作用域前綴類型前綴一個或多個單詞組成變量用小寫字母開頭的單詞組合而成，第二個單詞的首字母要大寫。例如：intnDrawMode。變量最長不得超過20個字符。特殊的：對于某些用途簡單明了的局部變量，也可以使用簡化的方式，如：i,j,k,x,y,z2、組成形式：變量的名字應(yīng)當(dāng)使用名詞或者形容詞名詞。例如：nCode,m_nState,nMaxWidth,oldValue,newValue。3、

8、作用域前綴：作用域前綴標明一個變量的可見范圍。作用域可以有如下幾種：前綴說明例子無局部變量m_類的成員變量(member)Intm_widthms_類的靜態(tài)成員變量(staticmember)staticintms_initValue;s_靜態(tài)變量(static)staticints_initValue;g外部全局變量(global)intg_howManyPeople;sg_靜態(tài)全局變量(staticglobal)gg進程間共享的共享數(shù)據(jù)段全局變量(globalglobal)說明：作用域前綴不同于下面的類型前綴，應(yīng)該堅決執(zhí)行。原因是：1）變量作用域和鏈接性改變的情況是很少的，例如，很少的情況

9、下會把一個成員變量改成靜態(tài)變量2）編程中使用的工具常常不會直觀的顯示變量的作用域和鏈接性4、類型前綴：作用域前綴標明一個變量的可見范圍。類型前綴標明一個變量的類型，有如下幾種：前綴說明例子b布爾型變量（bool，BOOL）bEnablech字符型變量（charTCHAR）chNamelpszLPSTR、LPCSTR、LPCTSTRlpszNamen整型和位域變量（int，uint，一int32,int64）nLengthllonglOffsetbyBYTEwWORDwPosdwDWORDdwRangef浮點型變量（float）ddoublep指針型變量和迭代子（pointer）pDoclp遠指

10、針e枚舉型變量（enumeration）pfn特別針對指向函數(shù)的指針變量和函數(shù)對象指針（pointeroffunction）g數(shù)組（grid）hhandleWindows對象句柄hWnd四、常量常量名由類型前綴全大寫字母組成，單詞間通過下劃線來界定，如：cDELIMITER,nMAX_BUFFER。類型前綴的定義與變量命名規(guī)則中的相同。五、結(jié)構(gòu)體、宏、枚舉變量、聯(lián)合體全部由前綴+大寫字母組成，單詞間使用下劃線界定。1、結(jié)構(gòu)體：加小寫前綴tag，之后以大寫字母開頭。例：typedefstructtagPOINTintx;inty;POINT;2、宏：大寫字母組成，單詞間使用下劃線界定例：#defineMAXNUMBER1003、枚舉變量：加小寫前綴