《編程命名規(guī)范》word版.doc

編程命名規(guī)范目 錄1.1 整體原則11.1.1 強(qiáng)制性命名規(guī)范11.1.2建議性命名規(guī)范11.2 詳細(xì)規(guī)范11.3 檢查原則21.1 整體原則1.1.1 強(qiáng)制性命名規(guī)范 同一性：在編寫一個(gè)子模塊或派生類的時(shí)候，要遵循其基類或整體模塊的命名風(fēng)格，保持命名風(fēng)格在整個(gè)模塊中的同一性。 標(biāo)識(shí)符組成：標(biāo)識(shí)符采用英文單詞或其組合，應(yīng)當(dāng)直觀且可以拼讀，使用注釋的方式表明其含義。 避免在不同級(jí)別的作用域中重名：程序中不要出現(xiàn)名字完全相同的局部變量和全局變量，盡管兩者的作用域不同而不會(huì)發(fā)生語(yǔ)法錯(cuò)誤，但容易使人誤解。 避免名字中出現(xiàn)數(shù)字編號(hào)：盡量避免名字中出現(xiàn)數(shù)字編號(hào)，如Value1,Value2等，除非邏輯上的確需要編號(hào)。這是為了防止程序員偷懶，不肯為命名動(dòng)腦筋而導(dǎo)致產(chǎn)生無(wú)意義的名字（因?yàn)橛脭?shù)字編號(hào)最省事）。1.1.2建議性命名規(guī)范 最小化長(zhǎng)度與最大化信息量原則：在保持一個(gè)標(biāo)識(shí)符意思明確的同時(shí)，應(yīng)當(dāng)盡量縮短其長(zhǎng)度。 避免過(guò)于相似：不要出現(xiàn)僅靠大小寫區(qū)分的相似的標(biāo)識(shí)符，例如“i”與“I”，“function”與“Function”等等。 正確命名具有互斥意義的標(biāo)識(shí)符：用正確的反義詞組命名具有互斥意義的標(biāo)識(shí)符，如：nMinValue和nMaxValue，GetName() 和 SetName()等等。1.2 詳細(xì)規(guī)范（1）類和接口：類名都以大寫字母“C”開頭，代表Class。接口以大寫I開頭，代表Interface。后跟一個(gè)或多個(gè)單詞，每個(gè)單詞的首字母要大寫。推薦用“名詞”或“形容詞名詞”的形式，例如：CAnalyzer, CFastVector等等。（2）函數(shù)：函數(shù)的名稱由一個(gè)或多個(gè)單詞組成，每個(gè)單詞的首字母要大寫，最長(zhǎng)不得超過(guò)20個(gè)字符。l 全局函數(shù)應(yīng)當(dāng)使用“動(dòng)詞”或者“動(dòng)詞名詞”（動(dòng)賓詞組）的形式，例如：GetName(), DrawBox()。l 類成員函數(shù)應(yīng)當(dāng)只使用“動(dòng)詞”，被省略掉的名詞就是對(duì)象本身。例如： box-Draw()。私有成員和保護(hù)成員函數(shù)的開頭應(yīng)當(dāng)加上一個(gè)下劃線“_”以示區(qū)別。虛函數(shù)習(xí)慣以“Do”開頭。l 回調(diào)和事件處理函數(shù)習(xí)慣以單詞“On”開頭。例如：OnTimer()。 （3）變量：變量是程序中使用最多的標(biāo)識(shí)符，變量名由“作用域前綴下劃線類型前綴變量名字”組成，例如：int g_iDrawMode。變量最長(zhǎng)不得超過(guò)20個(gè)字符。l 作用域前綴標(biāo)明一個(gè)變量的可見(jiàn)范圍，全部小寫字母。靜態(tài)變量以“s”表示。全局變量以“g”表示。局部變量以“l(fā)”為前綴。類的成員變量以“m”表示。類的靜態(tài)成員變量以“ms”表示。類的全局成員變量以“mg”表示，建議不要直接使用類的全局成員變量。l 類型前綴標(biāo)明一個(gè)變量的類型，全部小寫字母。布爾型變量以“b”表示。字符型變量以“c”表示。字符串變量以“s”表示。整型和位域變量以“n”表示。長(zhǎng)整型變量以“l(fā)”表示。浮點(diǎn)型變量以“f”表示。字節(jié)型變量（BYTE）以“by”表示。字（WORD）變量以“w”表示。數(shù)組以“g”表示。指針型變量以“p”表示。枚舉型變量以“e”表示。結(jié)構(gòu)體變量以“st”表示。對(duì)象句柄以“h”表示。類的實(shí)例以“i”表示。l 變量名字應(yīng)當(dāng)使用“名詞”或者“形容詞名詞”形式，一個(gè)或多個(gè)單詞組成，每個(gè)單詞的首字母要大寫。l 對(duì)于某些用途簡(jiǎn)單明了的局部變量（for、while），也可以使用簡(jiǎn)化的方式，如：i, j, k, x, y, z。（4）常量：由“類型前綴常量名字”組成。常量名字由全大寫字母組成，單詞間通過(guò)下劃線來(lái)界定，如：cDELIMITER, nMAX_BUFFER。類型前綴的定義與變量命名規(guī)則中的相同。（5）結(jié)構(gòu)體、宏、枚舉、聯(lián)合體定義：全部大寫字母組成，單詞間通過(guò)下劃線來(lái)界定，如STUDENT_INFO。（6）注釋：注釋的位置應(yīng)與被描述的代碼相鄰，可以放在代碼的上方或右方，不可放在下方。l 邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。l 注釋應(yīng)當(dāng)準(zhǔn)確、易懂，防止注釋有二義性。錯(cuò)誤的注釋不但無(wú)益反而有害。l 當(dāng)代碼比較長(zhǎng)，特別是有多重嵌套時(shí)，應(yīng)當(dāng)在一些段落的結(jié)束處加注釋，便于閱讀。1.3 檢查原則1、對(duì)于強(qiáng)制性命名規(guī)范，