【文章內容簡介】 縮寫；一些單詞有大家公認的縮寫。 示例：如下單詞的縮寫能夠被大家基本認可。 temp 可縮寫為 tmp 。 flag 可縮寫為 flg 。 statistic 可縮寫為 stat 。 increment 可縮寫為 inc 。 message 可縮寫為 msg 。 185。32：命名中若使用特殊約定或縮寫，則要有注釋說明。 說明：應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。 185。33：自己特有的命名風格，要自始至終保持一致，不可來回變化。 說明：個人的命名風格，在符合所在項目組或產品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個人命名風格）。 185。34：對于變量命名，禁止取單個字符（如 i、 j、 k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據類型等，但 i、 j、 k作局部循環(huán)變量是允許的。 說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如 i寫成 j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。 示例：下面所示的局部變量名的定義方法可以借鑒。 int liv_Width 其變量名解釋如下： l 局部變量（ Local） （其它： g 全局變量（ Global） ...） i 數(shù)據類型（ Interger） v 變量（ Variable） （其它： c 常量（ Const） ...） Width 變量含義 軟件編程規(guī)范總則 3 標志符命名 僅供內部使用 18 這樣可 以防止局部變量與全局變量重名。 185。35：命名規(guī)范必須與所使用的系統(tǒng)風格保持一致，并在同一項目中統(tǒng)一，比如采用 UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標識如標識成員變量或全局變量的 m_和 g_，其后加上大小寫混排的方式是允許的。 示例： Add_User不允許， add_user、 AddUser、 m_AddUser允許。 189。31：除非必要，不要用數(shù)字或較奇怪的字符來定義標識符。 示例：如下命名，使人產生疑惑。 define _EXAMPLE_0_TEST_ define _EXAMPLE_1_TEST_ void set_sls00( BYTE sls )。 應改為有意義的單詞命名 define _EXAMPLE_UNIT_TEST_ define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls )。 189。32：在同一軟件產品內，應規(guī)劃好接口部分標識符（變量、結構、函數(shù)及常量）的命名，防止編譯、鏈接時產生沖突。 說明：對接口部分的標識符應該有更嚴格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加 上“模塊”標識等。 189。33：用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。 說明：下面是一些在軟件中常用的反義詞組。 add / remove begin / end create / destroy insert / delete first / last get / release increment / decrement put / get add / delete lock / unlock open / close min / max old / new start / stop next / previous source / target show / hide send / receive source / destination cut / paste up / down 示例： int min_sum。 軟件編程規(guī)范總則 3 標志符命名 僅供內部使用 19 int max_sum。 int add_user( BYTE *user_name )。 int delete_user( BYTE *user_name )。 189。34：除了編譯開關 /頭文件等特殊應用，應避免使用 _EXAMPLE_TEST_之類以下劃線開始和結尾的定義。 軟件編程規(guī)范總則 4 可讀性 僅供內部使用 20 4 可讀性 185。41：注意運算符的優(yōu)先級，并用括號明確表達式的操作順序，避免使用默認優(yōu)先級。 說明：防止閱讀程序時產生誤解，防止因默認的優(yōu)先級與設計思想不符而導致程序出錯。 示例：下列語句中的表達式 word = (high 8) | low (1) if ((a | b) amp。amp。 (a amp。 c)) (2) if ((a | b) (c amp。 d)) (3) 如果書寫為 high 8 | low a | b amp。amp。 a amp。 c a | b c amp。 d 由于 high 8 | low = ( high 8) | low, a | b amp。amp。 a amp。 c = (a | b) amp。amp。 (a amp。 c)， (1)(2)不會出錯，但語句不易理解； a | b c amp。 d = a | （ b c） amp。 d， (3)造成了判斷條件出錯。 185。42：避免使用不易理解的數(shù)字，用有意義的標識來替代。涉及 物理狀態(tài)或者含有物理意義的常量，不應直接使用數(shù)字，必須用有意義的枚舉或宏來代替。 示例：如下的程序可讀性差。 if (Trunk[index].trunk_state == 0) { Trunk[index].trunk_state = 1。 ... // program code } 應改為如下形式。 define TRUNK_IDLE 0 define TRUNK_BUSY 1 if (Trunk[index].trunk_state == TRUNK_IDLE) { Trunk[index].trunk_state = TRUNK_BUSY。 軟件編程規(guī)范總則 4 可讀性 僅供內部使用 21 ... // program code } 189。41：源程序中關系較為緊密的代碼應盡可能相鄰。 說明：便于程序閱讀和查找。 示例：以下代碼布局不太合理。 = 10。 char_poi = str。 = 5。 若按如下形式書寫，可能更清晰一些。 = 10。 = 5。 // 矩形的長與寬關系較密切，放在一起。 char_poi = str。 189。42：不要使用難懂的技巧性很高的語句，除非很有必要時。 說明：高技巧語句不等于高效率的程序，實際上程序的效率關鍵在于算法。 示例：如下表達式，考慮不周就可能出問題，也較難理解。 * stat_poi ++ += 1。 * ++ stat_poi += 1。 應分別改為如下。 *stat_poi += 1。 stat_poi++。 // 此二語句功能相當于“ * stat_poi ++ += 1。 ” ++ stat_poi。 *stat_poi += 1。 // 此二語句功能相當于“ * ++ stat_poi += 1。 ” 軟件編程規(guī)范總則 5 變量、結構 僅供內部使用 22 5 變量、結構 185。51：去掉沒必要的公共變量。 說明：公共變量是增大模塊間耦合的原因之一，故應減少沒必要的公共變量以降低模塊間的耦合度。 185。52：仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系。 說明：在對變量聲明的同時，應對其含義、作用及取值范圍進行注釋說明，同時若有必要還應說明與其它變量的關系。 185。53：明確公共變量與操作此公共變量的函數(shù)或過程的關系，如訪問、修改及創(chuàng)建等。 說明：明確過程操作變量的關系后，將有利于程序的進一步優(yōu)化、單元測試、 系統(tǒng)聯(lián)調以及代碼維護等。這種關系的說明可在注釋或文檔中描述。 示例：在源文件中，可按如下注釋形式說明。 RELATION System_Init Input_Rec Print_Rec Stat_Score Student Create Modify Access Access Score Create Modify Access Access, Modify 注： RELATION為操作關 系； System_Init、 Input_Rec、 Print_Rec、 Stat_Score為四個不同的函數(shù)； Student、 Score為兩個全局變量； Create表示創(chuàng)建， Modify表示修改， Access表示訪問。 其中，函數(shù) Input_Rec、 Stat_Score都可修改變量 Score，故此變量將引起函數(shù)間較大的耦合，并可能增加代碼測試、維護的難度。 185。54：當向公共變量傳遞數(shù)據時，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。 說明：對公共變量賦值時，若有必要應進行合法性檢查，以提高代碼的可靠性、穩(wěn)定 性。 185。55：防止局部變量與公共變量同名。 說明：若使用了較好的命名規(guī)則，那么此問題可自動消除。 185。56：嚴禁使用未經初始化的變量作為右值。 說明：特別是在 C/C++中引用未經賦值的指針，經常會引起系統(tǒng)崩潰。 軟件編程規(guī)范總則 5 變量、結構 僅供內部使用 23 189。51：構造僅有一個模塊或函數(shù)可以修改、創(chuàng)建，而其余有關模塊或函數(shù)只訪問的公共變量，防止多個不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。 說明：降低公共變量耦合度。 189。52：使用嚴格形式定義的、可移植的數(shù)據類型，盡量不要使用與具體硬件或軟件環(huán)境關系密切的變量。 說明：使用標準的數(shù)據類型，有利于程 序的移植。 示例：如下例子（在 DOS下 ），在移植時可能產生問題。 void main() { register int index。 // 寄存器變量 _AX = 0x4000。 // _AX 是 “偽變量” ... // program code } 189。53：結構的功能要單一，是針對一種事務的抽象。 說明：設計結構時應力爭使結構代表一種現(xiàn)實事務的抽象，而不是同時代表多種。結構中的各元素應代表同一事務的不同側面，而不應把描述沒有關系或關系很弱的不同 事務的元素放到同一結構中。 示例：如下結構不太清晰、合理。 typedef struct STUDENT_STRU { unsigned char name[8]。 /* student39。s name */ unsigned char age。 /* student39。s age */ unsigned char sex。 /* student39。s sex, as follows */ /* 0 FEMALE。 1 MALE */ unsigned char teacher_name[8]。 /* the student teacher39。s name */ unisgned char teacher_sex。 /* his teacher sex */ } STUDENT。 若改為如下，可能更合理些。 軟件編程規(guī)范總則 5 變量、結構 僅供內部使用 24 typedef struct TEACHER_STRU { unsig