1、軟件代碼編程規(guī)范制訂：劉志敏審核：_批準：_ 文 件 修 訂 記 錄文件名稱工程設計變更管理程序編號F-02-002 版次修訂內(nèi)容修改頁次修訂日期修訂者備注A00新版本發(fā)行2008-12-02劉志敏 1. 目的1.1. 標準化軟件工作流程1.2. 規(guī)范編程代碼條理清晰，提高程序擴展性1.3. 提高軟件發(fā)布質(zhì)量,減少出錯幾率1.4. 規(guī)范注釋和代碼風格簡單易讀,方便格式化處理便于后期移交和維護2. 適用范圍軟件系統(tǒng)架構(gòu)師、軟件工程師、軟件技術總監(jiān)/副總監(jiān)、軟件主管3. 代碼規(guī)范3.1. 排版3.1.1. 程序塊要采用縮進風格編寫，縮進采用TAB鍵方式。（TAB鍵設置的空格數(shù)為4個）說明：對于由開

2、發(fā)工具自動生成的代碼可以有不一致3.1.2. 較長的語句（80字符）要分成多行書寫，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當?shù)目s進，使排版整齊，語句可讀, 示例:perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied = stat_poiindex.occupied;act_task_tabletaskn

3、o.duration_true_or_false = SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = (taskno MAX_ACT_TASK_NUMBER) & (n7stat_stat_item_valid (stat_item) & (act_task_tabletaskno.result_data != 0);if (taskno ），后不應加空格說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰由于留空格所產(chǎn)生的清晰性是相對的，所以，在已經(jīng)非常清晰的語句中沒有必要再留空格，如果語句已足夠清晰則括號內(nèi)側(cè)(即

4、左括號后面和右括號前面)不需要加空格，多重括號間不必加空格，因為在C/C+語言中括號已經(jīng)是最清晰的標志了。在長語句中，如果需要加的空格非常多，那么應該保持整體清晰，而在局部不加空格。給操作符留空格時不要連續(xù)留兩個以上空格示例:(1) 逗號、分號只在后面加空格。int a, b, c; (2)比較操作符, 賦值操作符=、 +=，算術操作符+、%，邏輯操作符&、&，位域操作符= MAX_TIME_VALUE) a = b + c;a *= 2;a = b 2;(3)!、+、-、&（地址運算符）等單目操作符前后不加空格。*p = a; / 內(nèi)容操作*與內(nèi)容之間flag = !isEmpty; / 非

5、操作!與內(nèi)容之間p = &mem; / 地址操作& 與內(nèi)容之間i+; / +,-與內(nèi)容之間(4)-、.前后不加空格。p-id = pid; / -指針前后不加空格(5) if、for、while、switch等與后面的括號間應加空格，使if等關鍵字更為突出、明顯。if (a = b & c d)3.1.8. 一行程序以小于80字符為宜，不要寫得過長3.1.9. 在使用“= =”判斷語句時，如有常數(shù)，常數(shù)最好放在“= =”左邊, 以避免少寫成“=”時，編譯器不能不錯3.2. 注釋3.2.1. 說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準確、

6、易懂、簡潔3.2.2. 說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應進行注釋，注釋必須列出：版權說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的關系、修改日志等，頭文件的注釋中還應有函數(shù)功能簡要說明示例：下面這段頭文件的頭注釋比較標準，當然，并不局限于此格式，但上述信息建議要包含在內(nèi):/* Copyright (C), 1998-2007, Tenda Tech. Co., Ltd. File name: / 文件名 Author: Version: Date: / 作者、版本及完成日期 Description: / 用于詳細說明此程序文件完成

7、的主要功能，與其他模塊 / 或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控 / 制、順序、獨立或依賴等關系 Others: / 其它內(nèi)容的說明 Function List: / 主要函數(shù)列表，每條記錄應包括函數(shù)名及功能簡要說明 1. . History: / 修改歷史記錄列表，每條修改記錄應包括修改日期、修改 / 者及修改內(nèi)容簡述 1. Date: Author: Modification: 2. .*/3.2.3. 源文件頭部應進行注釋，列出：版權說明、版本號、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等示例：下面這段源文件的頭注釋比較標準，當然，并不局限于此格式，但上述信

8、息建議要包含在內(nèi):/* Copyright (C), 1998-2007, Tenda Tech. Co., Ltd. FileName: test.cpp Author: Version : Date: Description: / 模塊描述 Version: / 版本信息 Function List: / 主要函數(shù)及其功能 1. - History: / 歷史修改記錄 David 96/10/12 1.0 build this moudle */說明：Description一項描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關系及本文件與其它文件關系等。History是修改歷史記錄列表，每條修改記

9、錄應包括修改日期、修改者及修改內(nèi)容簡述3.2.4. 函數(shù)頭部應進行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關系（函數(shù)、表）等示例：下面這段函數(shù)的注釋比較標準，當然，并不局限于此格式，但上述信息建議要包含在內(nèi):/* Function: / 函數(shù)名稱 Description: / 函數(shù)功能、性能等的描述 Input: / 輸入?yún)?shù)說明，包括每個參數(shù)的作 / 用、取值說明及參數(shù)間關系。 Output: / 對輸出參數(shù)的說明。 Return: / 函數(shù)返回值的說明 Others: / 其它說明*/3.2.5. 邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。

10、不再有用的注釋要刪除.3.2.6. 注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性說明：錯誤的注釋不但無益反而有害3.2.7. 避免在注釋中使用縮寫，特別是非常用縮寫說明：在使用縮寫時或之前，應對縮寫進行必要的說明3.2.8. 注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開:示例：如下例子不符合規(guī)范例1：/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn

11、_ni = ssn_dataindex.ni;例2：repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */應如下書寫/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;3.2.9. 對于所有有物理含義的變量、常量，

12、如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應放在其上方相鄰位置或右方示例:/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task */3.2.10. 數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋放在此域的右方示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合

13、結(jié)構(gòu):/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVE N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND,/* sccp notify user the No.7 network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp users unit dtransmission request*/;3.2

14、.11. 全局變量要有較詳細的注釋，包括對其功能、取值范圍、以及存取時注意事項等的說明示例:/* 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

15、it through call */* the function GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode;3.2.12. 注釋與所描述內(nèi)容進行同樣的縮說明：可使程序排版整齊，并方便注釋的閱讀與理解示例：如下例子，排版不整齊，閱讀稍感不方便void example_fun( void )/* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two應改為如下布局。void example_fun( void ) /* code one com

16、ments */ CodeBlock One /* code two comments */ CodeBlock Two3.2.13. 將注釋與其上面的代碼用空行隔開示例：如下例子，顯得代碼過于緊湊/* code one comments */program code one/* code two comments */program code two應如下書寫/* code one comments */program code one/* code two comments */program code two3.2.14. 對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋說明：

17、這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關鍵，對于維護人員來說，良好的注釋幫助更好的理解程序，有時甚至優(yōu)于看設計文檔3.2.15. 對于switch語句下的case語句，如果因為特殊情況需要處理完一個case后進入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句示例（注意斜體加粗部分）：case CMD_UP:ProcessUp(); break;case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); if (.) . brea

18、k;else ProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;case CMD_C: ProcessC(); break;case CMD_D: ProcessD(); break;.3.2.16. 避免在一行代碼或表達式的中間插入注說明：除非必要，不應在代碼或表達中間插入注釋，否則容易使代碼可理解性變差3.2.17. 通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的說明：清晰準確的函數(shù)、變量等的命名，可

19、增加代碼可讀性，并減少不必要的注釋3.2.18. 在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復注釋信息。示例：如下注釋意義不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注釋則給出了額外有用的信息。 /* if mtp receive a message from links */if (receive_flag)3.2.19. 在程序塊的結(jié)束行右方加注釋標記，以表明某程序塊的結(jié)束說明：當代碼段較長，特別是多重嵌套時，這樣

20、做可以使代碼更清晰，更便于閱讀。示例：參見如下例子:if (.) / program code while (index MAX_INDEX) / program code /* end of while (index MAX_INDEX) */ 指明該條while語句結(jié)束 /* end of if (.)*/ / 指明是哪條if語句結(jié)束3.2.20. 注釋格式盡量統(tǒng)一，建議使用“/* */”3.2.21. 注釋應考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準確的英文表達說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護人員的考慮，建議使用

21、中文3.3. 標識符命名3.3.1. 標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。示例：如下單詞的縮寫能夠被大家基本認可。temp 可縮寫為 tmp ;flag 可縮寫為 flg ;statistic 可縮寫為 stat ;increment 可縮寫為 inc ;message 可縮寫為 msg ;3.3.2. 命名中若使用特殊約定或縮寫，則要有注釋說明說明：應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行

22、必要的注釋說明3.3.3. 自己特有的命名風格，要自始至終保持一致，不可來回變化說明：個人的命名風格，在符合所在項目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個人命名風格）3.3.4. 對于變量命名，禁止取單個字符（如i、j、k.），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。示例：下面所示的局部變量名的定義方法可以借鑒。int liv_Width其變量名解釋如下：l 局部變

23、量（Local） （其它：g 全局變量（Global）.）i 數(shù)據(jù)類型（Interger）v 變量（Variable） （其它：c 常量（Const）.）Width 變量含義這樣可以防止局部變量與全局變量重名3.3.5. 命名規(guī)范必須與所使用的系統(tǒng)風格保持一致，并在同一項目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標識如標識成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的示例： Add_User不允許，add_user、AddUser、m_AddUser允許3.3.6. 除非必要，不要用數(shù)字或較奇怪的字符來定義標

24、識符示例：如下命名，使人產(chǎn)生疑惑。#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 );3.3.7. 在同一軟件產(chǎn)品內(nèi)，應規(guī)劃好接口部分標識符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時產(chǎn)生沖突說明：對接口部分的標識符應該有更嚴格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標識等3

25、.3.8. 用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(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 sou

26、rce / destinationcut / paste up / down示例：int min_sum;int max_sum;int add_user( BYTE *user_name );int delete_user( BYTE *user_name );3.3.9. 除了編譯開關/頭文件等特殊應用，應避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義3.4. 可讀性3.4.1. 注意運算符的優(yōu)先級，并用括號明確表達式的操作順序，避免使用默認優(yōu)先級說明：防止閱讀程序時產(chǎn)生誤解，防止因默認的優(yōu)先級與設計思想不符而導致程序出錯。示例：下列語句中的表達式word = (high

27、 8) | low (1)if (a | b) & (a & c) (2)if (a | b) (c & d) (3)如果書寫為high 8 | lowa | b & a & ca | b c & d由于high 8 | low = ( high 8) | low,a | b & a & c = (a | b) & (a & c)，(1)(2)不會出錯，但語句不易理解；a | b c & d = a | （b c） & d，(3)造成了判斷條件出錯3.4.2. 避免使用不易理解的數(shù)字，用有意義的標識來替代。涉及物理狀態(tài)或者含有物理意義的常量，不應直接使用數(shù)字，必須用有意義的枚舉或宏來代替示例：

28、如下的程序可讀性差。if (Trunkindex.trunk_state = 0) Trunkindex.trunk_state = 1; . / program code應改為如下形式。#define TRUNK_IDLE 0#define TRUNK_BUSY 1if (Trunkindex.trunk_state = TRUNK_IDLE) Trunkindex.trunk_state = TRUNK_BUSY; . / program code3.4.3. 源程序中關系較為緊密的代碼應盡可能相鄰說明：便于程序閱讀和查找。示例：以下代碼布局不太合理。rect.length = 10;ch

29、ar_poi = str;rect.width = 5;若按如下形式書寫，可能更清晰一些。rect.length = 10;rect.width = 5; / 矩形的長與寬關系較密切，放在一起。char_poi = str;3.4.4. 不要使用難懂的技巧性很高的語句，除非很有必要時說明：高技巧語句不等于高效率的程序，實際上程序的效率關鍵在于算法。示例：如下表達式，考慮不周就可能出問題，也較難理解。* stat_poi + += 1;* + stat_poi += 1;應分別改為如下。*stat_poi += 1;stat_poi+; / 此二語句功能相當于“ * stat_poi + +=

30、1; ”+ stat_poi;*stat_poi += 1; / 此二語句功能相當于“ * + stat_poi += 1; ”可讀性3.4.5. 去掉沒必要的公共變量說明：公共變量是增大模塊間耦合的原因之一，故應減少沒必要的公共變量以降低模塊間的耦合度3.4.6. 仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系說明：在對變量聲明的同時，應對其含義、作用及取值范圍進行注釋說明，同時若有必要還應說明與其它變量的關系3.4.7. 明確公共變量與操作此公共變量的函數(shù)或過程的關系，如訪問、修改及創(chuàng)建等說明：明確過程操作變量的關系后，將有利于程序的進一步優(yōu)化、單元測試、系統(tǒng)聯(lián)調(diào)以及代碼維

31、護等。這種關系的說明可在注釋或文檔中描述。示例：在源文件中，可按如下注釋形式說明。RELATION System_Init Input_Rec Print_Rec Stat_ScoreStudent Create Modify Access AccessScore Create Modify Access Access, Modify注：RELATION為操作關系；System_Init、Input_Rec、Print_Rec、Stat_Score為四個不同的函數(shù)；Student、Score為兩個全局變量；Create表示創(chuàng)建，Modify表示修改，Access表示訪問。其中，函數(shù)Input_

32、Rec、Stat_Score都可修改變量Score，故此變量將引起函數(shù)間較大的耦合，并可能增加代碼測試、維護的難度3.4.8. 當向公共變量傳遞數(shù)據(jù)時，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生說明：對公共變量賦值時，若有必要應進行合法性檢查，以提高代碼的可靠性、穩(wěn)定性3.4.9. 防止局部變量與公共變量同名說明：若使用了較好的命名規(guī)則，那么此問題可自動消除3.4.10. 嚴禁使用未經(jīng)初始化的變量作為右值說明：特別是在C/C+中引用未經(jīng)賦值的指針，經(jīng)常會引起系統(tǒng)崩潰3.4.11. 構(gòu)造僅有一個模塊或函數(shù)可以修改、創(chuàng)建，而其余有關模塊或函數(shù)只訪問的公共變量，防止多個不同模塊或函數(shù)都可以修改、

33、創(chuàng)建同一公共變量的現(xiàn)象說明：降低公共變量耦合度3.4.12. 使用嚴格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關系密切的變量說明：使用標準的數(shù)據(jù)類型，有利于程序的移植。示例：如下例子（在DOS下BC3.1環(huán)境中），在移植時可能產(chǎn)生問題。void main() register int index; / 寄存器變量 _AX = 0x4000; / _AX是BC3.1提供的寄存器“偽變量” . / program code3.4.13. 結(jié)構(gòu)的功能要單一，是針對一種事務的抽象說明：設計結(jié)構(gòu)時應力爭使結(jié)構(gòu)代表一種現(xiàn)實事務的抽象，而不是同時代表多種。結(jié)構(gòu)中的各元素應代表同一事務的

34、不同側(cè)面，而不應把描述沒有關系或關系很弱的不同事務的元素放到同一結(jié)構(gòu)中。示例：如下結(jié)構(gòu)不太清晰、合理。typedef struct STUDENT_STRU unsigned char name8; /* students name */ unsigned char age; /* students age */ unsigned char sex; /* students sex, as follows */ /* 0 - FEMALE; 1 - MALE */ unsigned char teacher_name8; /* the student teachers name */ unis

35、gned char teacher_sex; /* his teacher sex */ STUDENT;若改為如下，可能更合理些。typedef struct TEACHER_STRU unsigned char name8; /* teacher name */ unisgned char sex; /* teacher sex, as follows */ /* 0 - FEMALE; 1 - MALE */ TEACHER;typedef struct STUDENT_STRU unsigned char name8; /* students name */ unsigned char

36、 age; /* students age */ unsigned char sex; /* students sex,as follows */ /* 0 - FEMALE; 1 - MALE */ unsigned int teacher_ind; /* his teacher index */ STUDENT;3.4.14. 不要設計面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)說明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難3.4.15. 不同結(jié)構(gòu)間的關系不要過于復雜說明：若兩個結(jié)構(gòu)間關系較復雜、密切，那么應合為一個結(jié)構(gòu)。示例：如下兩個結(jié)構(gòu)的構(gòu)造不合理。typedef struct PERSON

37、_ONE_STRU unsigned char name8; unsigned char addr40; unsigned char sex; unsigned char city15; PERSON_ONE;typedef struct PERSON_TWO_STRU unsigned char name8; unsigned char age; unsigned char tel; PERSON_TWO;由于兩個結(jié)構(gòu)都是描述同一事物的，那么不如合成一個結(jié)構(gòu)。typedef struct PERSON_STRU unsigned char name8; unsigned char age;

38、unsigned char sex; unsigned char addr40; unsigned char city15; unsigned char tel; PERSON;3.4.16. 結(jié)構(gòu)中元素的個數(shù)應適中。若結(jié)構(gòu)中元素個數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個數(shù)說明：增加結(jié)構(gòu)的可理解性、可操作性和可維護性。示例：假如認為如上的_PERSON結(jié)構(gòu)元素過多，那么可如下對之劃分。sex; /* students sex, typedef struct PERSON_BASE_INFO_STRU unsigned char name8; unsigned ch

39、ar age; unsigned char sex; PERSON_BASE_INFO;typedef struct PERSON_ADDRESS_STRU unsigned char addr40; unsigned char city15; unsigned char tel; PERSON_ADDRESS;typedef struct PERSON_STRU PERSON_BASE_INFO person_base; PERSON_ADDRESS person_addr; PERSON;3.4.17. 仔細設計結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象說

40、明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。typedef struct EXAMPLE_STRU unsigned int valid: 1; PERSON person; unsigned int set_flg: 1; EXAMPLE;若改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。typedef struct EXAMPLE_STRU unsigned int valid: 1; unsigned int set_flg: 1; PERSON person ; EXAMPLE;3.4.18. 結(jié)構(gòu)的設計要盡量考慮向

41、前兼容和以后的版本升級，并為某些未來可能的應用保留余地（如預留一些空間等）說明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標志之一。如果要想使產(chǎn)品具有較好的前向兼容，那么在產(chǎn)品設計之初就應為以后版本升級保留一定余地，并且在產(chǎn)品升級時必須考慮前一版本的各種特性3.4.19. 留心具體語言及編譯器處理不同數(shù)據(jù)類型的原則及有關細節(jié)說明：如在C語言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部變量將在“堆?！敝猩?。這些細節(jié)對程序質(zhì)量的保證非常重要3.4.20. 編程時，要注意數(shù)據(jù)類型的強制轉(zhuǎn)換說明：當進行數(shù)據(jù)類型強制轉(zhuǎn)換時，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而這

42、些細節(jié)若考慮不周，就很有可能留下隱患3.4.21. 對編譯系統(tǒng)默認的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認識示例：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。char chr;unsigned short int exam;chr = -1;exam = chr; / 編譯器不產(chǎn)生告警，此時exam為0xFFFF3.4.22. 盡量減少沒有必要的數(shù)據(jù)類型默認轉(zhuǎn)換與強制轉(zhuǎn)換3.4.23. 合理地設計數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進行不必要的類型轉(zhuǎn)換3.4.24. 對自定義數(shù)據(jù)類型進行恰當命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一說明：使用自定義類型，可以

43、彌補編程語言提供類型少、信息量不足的缺點，并能使程序清晰、簡潔。示例：可參考如下方式聲明自定義數(shù)據(jù)類型。下面的聲明可使數(shù)據(jù)類型的使用簡潔、明了。typedef unsigned char BYTE;typedef unsigned short WORD;typedef unsigned int DWORD;下面的聲明可使數(shù)據(jù)類型具有更豐富的含義。typedef float DISTANCE;typedef float SCORE;3.4.25. 當聲明用于分布式環(huán)境或不同CPU間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時，必須考慮機器的字節(jié)順序、使用的位域及字節(jié)對齊等問題說明：比如Intel CPU與68360 CPU，在處理位域及整數(shù)時，其在內(nèi)存存放的“順序”正好相反。示例：假如有如下短整數(shù)及結(jié)構(gòu)。unsigned short int exam;typedef struct EXAM_BIT_STRU /* Intel 68360 */ unsigned int A1: 1; /* bit 0 7 */ unsigned int A2: 1; /* bit 1 6 */ unsigned int A3: 1; /* bit 2