【正文】 應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋放在此域的右方。/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVE{ N_UNITDATA_IND, /* sccp notify sccp user unit data e */ N_NOTICE_IND, /* sccp notify user the network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp user39。185。示例：/* The ErrorCode when SCCP translate *//* Global Title failure, as follows */ // 變量作用、含義/* 0 － SUCCESS 1 － GT Table error *//* 2 － GT error Others － no use */ // 變量取值范圍/* only function SCCPTranslate() in *//* this modual can modify it, and other *//* module can visit it through call *//* the function GetGTTransErrorCode() */ // 使用方法BYTE g_GTTranErrorCode。 212：注釋與所描述內(nèi)容進行同樣的縮排。示例：如下例子，排版不整齊，閱讀稍感不方便。void example_fun( void ){ /* code one ments */ CodeBlock One /* code two ments */ CodeBlock Two}185。示例：如下例子，顯得代碼過于緊湊。 214：對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。185。說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。 break。 break。 if (...){ ... break。 // now jump into case CMD_A}case CMD_A: ProcessA()。case CMD_B: ProcessB()。case CMD_C: ProcessC()。case CMD_D: ProcessD()。...189。說明：除非必要，不應(yīng)在代碼或表達中間插入注釋，否則容易使代碼可理解性變差。 22：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。189。說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。/* if receive_flag is TRUE */if (receive_flag)而如下的注釋則給出了額外有用的信息。 24：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。示例：參見如下例子。 25：注釋格式盡量統(tǒng)一，建議使用“/* …… */”。 26：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達。3 標(biāo)識符命名185。說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。temp 可縮寫為 tmp 。statistic 可縮寫為 stat 。message 可縮寫為 msg 。 32：命名中若使用特殊約定或縮寫，則要有注釋說明。185。說明：個人的命名風(fēng)格，在符合所在項目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。185。說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。int liv_Width其變量名解釋如下： l 局部變量（Local） （其它：g 全局變量（Global）...） i 數(shù)據(jù)類型（Interger） v 變量（Variable） （其它：c 常量（Const）...） Width 變量含義這樣可以防止局部變量與全局變量重名。 35：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標(biāo)識如標(biāo)識成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的。 189。示例：如下命名，使人產(chǎn)生疑惑。應(yīng)改為有意義的單詞命名define _EXAMPLE_UNIT_TEST_define _EXAMPLE_ASSERT_TEST_void set_udt_msg_sls( BYTE sls )。 32：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時產(chǎn)生沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識等。 33：用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。add / remove begin / end create / destroy insert / delete first / last get / releaseincrement / decrement put / getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / paste up / down示例：int min_sum。int add_user( BYTE *user_name )。189。 4 可讀性185。說明：防止閱讀程序時產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級與設(shè)計思想不符而導(dǎo)致程序出錯。amp。 c)) (2)if ((a | b) (c amp。amp。 ca | b c amp。amp。 c = (a | b) amp。 (a amp。 d = a | （b c） amp。185。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替。if (Trunk[index].trunk_state == 0){ Trunk[index].trunk_state = 1。define TRUNK_IDLE 0define TRUNK_BUSY 1if (Trunk[index].trunk_state == TRUNK_IDLE){ Trunk[index].trunk_state = TRUNK_BUSY。 41：源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。示例：以下代碼布局不太合理。char_poi = str。若按如下形式書寫，可能更清晰一些。 = 5。char_poi = str。 42：不要使用難懂的技巧性很高的語句，除非很有必要時。示例：如下表達式，考慮不周就可能出問題，也較難理解。* ++ stat_poi += 1。*stat_poi += 1。 // 此二語句功能相當(dāng)于“ * stat_poi ++ += 1。*stat_poi += 1。 ”5 變量、結(jié)構(gòu)185。說明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少沒必要的公共變量以降低模塊間的耦合度。 52：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。185。說明：明確過程操作變量的關(guān)系后，將有利于程序的進一步優(yōu)化、單元測試、系統(tǒng)聯(lián)調(diào)以及代碼維護等。示例：在源文件中，可按如下注釋形式說明。其中，函數(shù)Input_Rec、Stat_Score都可修改變量Score，故此變量將引起函數(shù)間較大的耦合，并可能增加代碼測試、維護的難度。 54：當(dāng)向公共變量傳遞數(shù)據(jù)時，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。185。說明：若使用了較好的命名規(guī)則，那么此問題可自動消除。 56：嚴(yán)禁使用未經(jīng)初始化的變量作為右值。189。說明：降低公共變量耦合度。 52：使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)系密切的變量。示例：如下例子（），在移植時可能產(chǎn)生問題。 // 寄存器變量 _AX = 0x4000。 53：結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。typedef struct STUDENT_STRU{ unsigned char name[8]。s name */ unsigned char age。s age */ unsigned char sex。s sex, as follows */ /* 0 FEMALE。 /* the student teacher39。 /* his teacher sex */} STUDENT。typedef struct TEACHER_STRU{ unsigned char name[8]。 /* teacher sex, as follows */ /* 0 FEMALE。typedef struct STUDENT_STRU{ unsigned char name[8]。s name */ unsigned char age。s age */ unsigned char sex。s sex, as follows */ /* 0 FEMALE。 /* his teacher index */} STUDENT。 54：不要設(shè)計面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)。189。說明：若兩個結(jié)構(gòu)間關(guān)系較復(fù)雜、密切，那么應(yīng)合為一個結(jié)構(gòu)。typedef struct PERSON_ONE_STRU{ unsigned char name[8]。 unsigned char sex。} PERSON_ONE。 unsigned char age。} PERSON_TWO。typedef struct PERSON_STRU{ unsigned char name[8]。 unsigned char sex。 unsigned char city[15]。} PERSON。 56：結(jié)構(gòu)中元素的個數(shù)應(yīng)適中。說明：增加結(jié)構(gòu)的可理解性、可操作性和可維護性。typedef struct PERSON_BASE_INFO_STRU{ unsigned char name[8]。 unsigned char sex。typedef struct PERSON_ADDRESS_STRU{ unsigned char addr[40]。 unsigned char tel。typedef struct PERSON_STRU{ PERSON_BASE_INFO person_base。} PERSON。 57：仔細(xì)設(shè)計結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象。示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。 PERSON person。} EXAMPLE。typedef struct EXAMPLE_STRU{ unsigned int valid: 1。 PERSON person 。189。說明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標(biāo)志之一。189。說明：如在C語言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部變量將在“堆棧”中生成。189。說明：當(dāng)進行數(shù)據(jù)類型強制轉(zhuǎn)換時，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而這些細(xì)節(jié)若考慮不周，就很有可能留下隱患。 511：對編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認(rèn)識。char chr。chr = 1。 // 編譯器不產(chǎn)生告警，此時exam為0xFFFF。 512：盡量減少沒有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強制轉(zhuǎn)換。 513：合理地設(shè)計數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進行不必要的類型轉(zhuǎn)換。 514：對自定義數(shù)據(jù)類型進行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。說明：使用自定義類型，可以彌補編程語言提供類型少、信息量不足的缺點，并能使程序清晰、簡潔。下面的聲明可使數(shù)據(jù)類型的使用簡潔、明了。typedef unsigned short WORD。下面的聲明可使數(shù)據(jù)類型具有更豐富的含