華為軟件編程規(guī)范和范例

1、華為軟件編程標(biāo)準(zhǔn)和范例1. 排版 11.1 程序塊要采用縮進(jìn)風(fēng)格編寫 , 縮進(jìn)的空格數(shù)為 4 個(gè)。 說明 : 對(duì)于由開發(fā)工具自動(dòng)生成的代碼可以有不一致。1.2 相對(duì)獨(dú)立的程序塊之間、變量說明之后必須加空行。 例如 : 如下例子不符合標(biāo)準(zhǔn)。if (!valid_ni(ni) . / program code repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; 應(yīng)如下書寫 : if (!valid_ni(ni) . / program code repssn_ind = ssn_dataindex.repss

2、n_index; repssn_ni = ssn_dataindex.ni;1.3 較長(zhǎng)的語句 (>80 字符 )要分成多行書寫 , 長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行 操作符放在新行之首 , 劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn) , 使排版整齊 , 語句可讀。例如 : 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_poi

3、index.occupied; act_task_tabletaskno.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);1.4 循環(huán)、判斷等語句中假設(shè)有較長(zhǎng)的表達(dá)式或語句 , 那么要進(jìn)行適應(yīng)的劃分 , 長(zhǎng)表達(dá)式要

4、 在低優(yōu)先級(jí)操作符處劃分新行 , 操作符放在新行之首。例如 : if (taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item) . / program code for (i = 0, j = 0; (i < BufferKeywordword_index.word_length)&& (j < NewKeyword.word_length); i+, j+) . / program code for (i = 0, j = 0;(i < first_word

5、_length) && (j < second_word_length);i+, j+). / program code1.5 假設(shè)函數(shù)或過程中的參數(shù)較長(zhǎng) , 那么要進(jìn)行適當(dāng)?shù)膭澐帧?例如 : n7stat_str_compare(BYTE *) & stat_object,(BYTE *) & (act_task_tabletaskno.stat_object), sizeof (_STAT_OBJECT);n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + i

6、ndex, stat_object );1.6 不允許把多個(gè)短語句寫在一行中 , 即一行只寫一條語句。 例如 : 如下例子不符合標(biāo)準(zhǔn)。rect.length = 0; rect.width = 0;應(yīng)如下書寫 rect.length = 0; rect.width = 0;1.7 if 、 for 、do、while 、case、 switch 、default 等語句自占一行 , 且 if 、for 、do、while 等語句的執(zhí)行語句局部無論多少都要加括號(hào) 。例如 : 如下例子不符合標(biāo)準(zhǔn)。if (pUserCR = NULL) return;應(yīng)如下書寫 :if (pUserCR = NUL

7、L)return;1.8 對(duì)齊只使用空格鍵 , 不使用 TAB 鍵。說明 : 以免用不同的編輯器閱讀程序時(shí) , 因 TAB 鍵所設(shè)置的空格數(shù)目不同而造成程序 布局不整齊 , 不要使用 BC 作為編輯器合版本 , 因?yàn)?BC 會(huì)自動(dòng)將 8 個(gè)空格變?yōu)橐粋€(gè) TAB 鍵 , 因此使用 BC 合入的版本大多會(huì)將縮進(jìn)變亂。1.9 函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格 , case 語句下的情況處理語句也要遵從語句縮進(jìn)要求。1.10 程序塊的分界符 (如 C/C+ 語言的大括號(hào) 和' )'應(yīng)各獨(dú)占一行并且位于同一列 同時(shí)與引用它們的語句左對(duì)齊。在函數(shù)體的開

8、始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以 及 if、 for 、 do、 while 、 switch 、case 語句中的程序都要采用如上的縮進(jìn)方式。例如 : 如下例子不符合標(biāo)準(zhǔn)。for (.) . / program codeif (.). / program codevoid example_fun( void )./ program code應(yīng)如下書寫。for (.)./ program codeif (.)./ program codevoid example_fun( void ) -./ program code1.11在兩個(gè)以上的關(guān)鍵字、 變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作

9、符之前、 之后 或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符(如->),后不應(yīng)加空格。說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。由于留空格所產(chǎn)生的清晰性是相對(duì)的，所以，在已經(jīng)非常清晰的語句中沒有必要再留空格，如果語句已足夠清晰那么括號(hào)內(nèi)側(cè)(即左括號(hào)后面和右括號(hào)前面)不需要加空格，多重括號(hào) 間不必加空格，因?yàn)樵贑/C+語言中括號(hào)已經(jīng)是最清晰的標(biāo)志了。在長(zhǎng)語句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。 給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。例如：(1) 逗號(hào)、分號(hào)只在后面加空格。int a, b, c;(2) 比擬操作符，賦值操作符“

10、 =、“ += ,算術(shù)操作符“ + 、“% ,邏輯操作符“&& 、 “ & ，位域操作符“ << 、“人等雙目操作符的前后加空格。if (current_time >= MAX_TIME_VALUE)a = b + c;a *= 2;a = b 人 2;(3) !"、"、+"、"-"、"&"(地址運(yùn)算符)等單目操作符前后不加空格。*p = 'a'/內(nèi)容操作"*"與內(nèi)容之間flag = !isEmpty; / 非操作"!"

11、與內(nèi)容之間p = &mem; /地址操作"&"與內(nèi)容之間i+;/與內(nèi)容之間"->"、"."前后不加空格。p->id = pid; / "->"指針前后不加空格(5) if、for、while、switch等與后面的括號(hào)間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。if (a >= b && c > d)1 一行程序以小于80字符為宜，不要寫得過長(zhǎng)。2.注釋1234562.1 一般情況下 , 源程序有效注釋量必須在 20以上。說明 : 注釋的原那么是有助于對(duì)程

12、序的閱讀理解, 在該加的地方都加了 , 注釋不宜太多也不能太少 , 注釋語言必須準(zhǔn)確、易懂、簡(jiǎn)潔。2.2 說明性文件 如頭文件 .h 文件、 .inc 文件、 .def 文件、編譯說明文件 .cfg 等 頭部應(yīng) 進(jìn)行注釋 , 注釋必須列出 : 版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件 的關(guān)系、修改日志等 , 頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要說明。例如 : 下面這段頭文件的頭注釋比擬標(biāo)準(zhǔn) , 當(dāng)然 , 并不局限于此格式 , 但上述信息建議 要包含在內(nèi)。/*文件名Date: / 作者、版本及完成日期 用于詳細(xì)說明此程序文件完成的主要功能 , 與其他模塊 或函數(shù)的接口 , 輸出值、取

13、值范圍、含義及參數(shù)間的控 制、順序、獨(dú)立或依賴等關(guān)系 其它內(nèi)容的說明 主要函數(shù)列表 , 每條記錄應(yīng)包括函數(shù)名及功能簡(jiǎn)要說明Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.File name: /Author: Version: Description: /Others: /Function List: /修改歷史記錄列表 , 每條修改記錄應(yīng)包括修改日期、修改 者及修改內(nèi)容簡(jiǎn)述1. .History: / /1. Date:Author:Modification:2. .*/2.3 源文件頭部應(yīng)進(jìn)行注釋 , 列出 : 版權(quán)說明、版本號(hào)、生成日期、作

14、者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。例如 : 下面這段源文件的頭注釋比擬標(biāo)準(zhǔn) , 當(dāng)然 , 并不局限于此格式 , 但上述信息建議要包含在內(nèi)。Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. FileName: test.cpp Author: Version :Description: /Version: /Function List: /1. .History: /<author> <time>Date:模塊描述版本信息 主要函數(shù)及其功能歷史修改記錄<version > <desc>

15、David 96/10/121.0 build this moudle*說明 : Description 一項(xiàng)描述本文件的內(nèi)容、功能、內(nèi)部各局部之間的關(guān)系及本文件與其 它文件關(guān)系等。 History 是修改歷史記錄列表 , 每條修改記錄應(yīng)包括修改日期、 修改者及修改 內(nèi)容簡(jiǎn)述。2.4 函數(shù)頭部應(yīng)進(jìn)行注釋 , 列出 : 函數(shù)的目的 / 功能、 輸入?yún)?shù)、 輸出參數(shù)、 返回值、 調(diào) 用關(guān)系 函數(shù)、表 等但上述信息建議要包例如: 下面這段函數(shù)的注釋比擬標(biāo)準(zhǔn) , 當(dāng)然 , 并不局限于此格式含在內(nèi)。Function:/函數(shù)名稱Description/函數(shù)功能、性能等的描述Calls:/被本函數(shù)調(diào)用的函數(shù)

16、清單Called By:/調(diào)用本函數(shù)的函數(shù)清單Table Accessed: /被訪問的表 ( 此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫操作的程序Table Updated: /被修改的表 ( 此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫操作的程序Input:/輸入?yún)?shù)說明 , 包括每個(gè)參數(shù)的作/用、取值說明及參數(shù)間關(guān)系。Output:/對(duì)輸出參數(shù)的說明。Return:/函數(shù)返回值的說明Others:/其它說明*2.5 邊寫代碼邊注釋 , 修改代碼同時(shí)修改相應(yīng)的注釋 , 以保證注釋與代碼的一致性。不 再有用的注釋要?jiǎng)h除。2.6 注釋的內(nèi)容要清楚、明了 , 含義準(zhǔn)確 , 防止注釋二義性。說明 : 錯(cuò)誤的注釋不但無益反而有害。2.7 防

17、止在注釋中使用縮寫 , 特別是非常用縮寫說明 : 在使用縮寫時(shí)或之前 , 應(yīng)對(duì)縮寫進(jìn)行必要的說明。2.8 注釋應(yīng)與其描述的代碼相近 , 對(duì)代碼的注釋應(yīng)放在其上方或右方(對(duì)單條語句的注釋 )相鄰位置 , 不可放在下面 , 如放于上方那么需與其上面的代碼用空行隔開。例如 : 如下例子不符合標(biāo)準(zhǔn)。例 1:/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;例 2:repssn_ind = ssn_datain

18、dex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */ 應(yīng)如下書寫/* get replicate sub system index and net indicator */ repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni;2.9 對(duì)于所有有物理含義的變量、常量 , 如果其命名不是充分自注釋的 , 在聲明時(shí)都必 須加以注釋 , 說明其物理含義。變量、常量、宏的

19、注釋應(yīng)放在其上方相鄰位置或右方。例如 :/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */2.10 數(shù)據(jù)結(jié)構(gòu)聲明 ( 包括數(shù)組、 結(jié)構(gòu)、類、枚舉等 ) , 如果其命名不是充分自注釋的 , 必 須加以注釋。 對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置 , 不可放在下面 ; 對(duì)結(jié)構(gòu)中的每個(gè)域 的注釋放在此域的右方。例如 : 可按如下形式說明枚舉 /數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。/* sccp interf

20、ace with sccp user primitive message name */enum SCCP_USER_PRIMITIVEN_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 user's unit data transmission request*/;2.11 全局變量要有較詳

21、細(xì)的注釋 及存取時(shí)考前須知等的說明。例如 :/* 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 GetG

22、TTransErrorCode() */ / BYTE g_GTTranErrorCode;, 包括對(duì)其功能、/取值范圍、 哪些函數(shù)或過程存取它以 變量作用、含義變量取值范圍使用方法2.12 注釋與所描述內(nèi)容進(jìn)行同樣的縮排。說明 : 可使程序排版整齊 , 并方便注釋的閱讀與理解。例如 : 如下例子 , 排版不整齊 , 閱讀稍感不方便。 void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two應(yīng)改為如下布局。void example_fun( void )/*

23、code one comments */CodeBlock One/* code two comments */CodeBlock Two2.13 將注釋與其上面的代碼用空行隔開。例如 : 如下例子 , 顯得代碼過于緊湊。/* code one comments */program code one/* code two comments */program code two應(yīng)如下書寫/* code one comments */ program code one/* code two comments */ program code two2.14對(duì)變量的定義和分支語句條件分支、循環(huán)語句等必

24、須編寫注釋。說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對(duì)于維護(hù)人員來說，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。2.15對(duì)于switch語句下的case語句,如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語句處理完、下一個(gè)case語句前加上明確的注釋。說明：這樣比擬清楚程序編寫者的意圖，有效防止無故遺漏 break語句。例如(注意斜體加粗局部):case CMD_UP:ProcessUp();break;case CMD_DOWN:ProcessDown();break;case CMD_FWD:ProcessFwd();if (.)bre

25、ak;elseProcessCFW_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;1防止在一行代碼或表達(dá)式的中間插入注釋。說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋 ，否那么容易使代碼可理解性變差。2通過對(duì)函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。說明：清晰準(zhǔn)確的函數(shù)、變量等的命名 ，可增加代碼可讀性，并減少不必要的注

26、釋。3在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。例如：如下注釋意義不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注釋那么給出了額外有用的信息。/* if mtp receive a message from links */if (receive_flag)4在程序塊的結(jié)束行右方加注釋標(biāo)記，以說明某程序塊的結(jié)束。說明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。 例如：參見如下例子。

27、if (.)/ program codewhile (index < MAX_INDEX)/ program code /* end of while (index < MAX_INDEX) */ /指明該條 while 語句結(jié)束 /* end of if (.)*/ /指明是哪條if語句結(jié)束5注釋格式盡量統(tǒng)一，建議使用“ /*/。6注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言假設(shè)是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對(duì)維護(hù)人員的考慮，建議使用中文。3.標(biāo)識(shí)符命名12343.1標(biāo)識(shí)符的命名要清晰、明了

28、解的縮寫，防止使人產(chǎn)生誤解。說明：較短的單詞可通過去掉 縮寫；一些單詞有大家公認(rèn)的縮寫。，有明確含義，同時(shí)使用完整的單詞或大家根本可以理元音形成縮寫；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成例如：如下單詞的縮寫能夠被大家根本認(rèn)可。temp可縮寫為tmp; 臨時(shí)flag可縮寫為flg; 標(biāo)志 statistic可縮寫為 stat ; 統(tǒng)計(jì) in creme nt可縮寫為inc; 增量 message可縮寫為 msg; 消息3.2命名中假設(shè)使用特殊約定或縮寫，那么要有注釋說明。特別是特殊的縮寫說明：應(yīng)該在源文件的開始之處，對(duì)文件中所使用的縮寫或約定進(jìn)行必要的注釋說明。3.3自己特有的命名風(fēng)格，要自始至終

29、保持一致，不可來回變化。說明：個(gè)人的命名風(fēng)格，在符合所在工程組或產(chǎn)品組的命名規(guī)那么的前提下，才可使用。(即命名規(guī)那么中沒有規(guī)定到的地方才可有個(gè)人命名風(fēng)格)。3.4對(duì)于變量命名，禁止取單個(gè)字符(如i、j、k.),建議除了要有具體含義外，還能說明 其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。說明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)(如i寫成j),而編譯時(shí) 又檢查不出來，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。例如：下面所示的局部變量名的定義方法可以借鑒。int liv_Width其變量名解釋如下：l局部變量(Local)( 其它：g 全局變量(Global)

30、.)i數(shù)據(jù)類型(Interger)v變量(Variable)( 其它：c 常量(Const).)Width 變量含義這樣可以防止局部變量與全局變量重名。3.5命名標(biāo)準(zhǔn)必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一工程中統(tǒng)一 ，比方采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標(biāo)識(shí)如 標(biāo)識(shí)成員變量或全局變量的m_和g_ ,其后加上大小寫混排的方式是允許的。例如：Add_User 不允許，add_user、AddUser、m_AddUser 允許。1除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符。 例如：如下命名，使人產(chǎn)生疑惑。#define _EXAM

31、PLE_O_TEST_#define _EXAMPLE_1_TEST_ void set_sls00( BYTE sls );應(yīng)改為有意義的單詞命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls );2在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口局部標(biāo)識(shí)符(變量、結(jié)構(gòu)、函數(shù)及常量)的命名，防止 編譯、鏈接時(shí)產(chǎn)生沖突。說明：對(duì)接口局部的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口局部的變量與常量之前加上模塊"標(biāo)識(shí)等。3用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)

32、等。 說明：下面是一些在軟件中常用的反義詞組。add / remove insert / delete increment / decrement lock / unlockold / new source / targetbegin / endcreate / destroyfirst / lastget / releaseput / get add / deleteopen / close min / maxstart / stop next / previousshow / hide send / receiveup/downsource / destination cut / past

33、e例如:int min_sum;int max_sum;intadd_user( BYTE *user_name );intdelete_user( BYTE *user_name );4除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)防止使用_EXAMPLE_TEST_ 之類以下劃線開 始和結(jié)尾的定義。4.可讀性124.1注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，防止使用默認(rèn)優(yōu)先級(jí)。說明：防止閱讀程序時(shí)產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級(jí)與設(shè)計(jì)思想不符而導(dǎo)致程序出 錯(cuò)。例如：以下語句中的表達(dá)式word = (high << 8) | low (1)if (a | b) && (

34、a & c)(2)if (a | b) < (c & d)如果書寫為：high << 8 | lowa | b && a & ca | b < c & d由于high << 8 | low等價(jià)于(high << 8) | lowa | b && a & c等價(jià)于(a | b) && (a & c)故(1)(2)不會(huì)出錯(cuò)，但語句不易理解，而a | b < c & d 等價(jià)于 a | (b < c) & d故(3)造成了判斷條件

35、出錯(cuò)。4.2防止使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替。例如：如下的程序可讀性差。if (Trunkindex.trunk_state = 0)Trunkindex.trunk_state = 1;./ program code應(yīng)改為如下形式。#define TRUNK_IDLE 0#define TRUNK_BUSY 1if 仃 runkindex.trunk_state = TRUNK_IDLE)Trunkindex.trunk_state = TRUNK_BUSY;./ program code1源程序

36、中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。 說明：便于程序閱讀和查找。例如：以下代碼布局不太合理。rect .l ength = 10;char_poi = str;rect.width = 5;假設(shè)按如下形式書寫，可能更清晰一些。rect .l ength = 10;rect.width = 5; /矩形的長(zhǎng)與寬關(guān)系較密切，放在一起。char_poi = str;不要使用難懂的技巧性很高的語句,除非很有必要時(shí)。說明：高技巧語句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于算法。例如：如下表達(dá)式，考慮不周就可能出問題，也較難理解。* stat_poi + += 1;* + stat_poi += 1;應(yīng)

37、分別改為如下：*stat_poi += 1;stat_poi+;/ 此二語句功能相當(dāng)于“ * stat_poi + += 1;和+ stat_poi;*stat_poi += 1; /此二語句功能相當(dāng)于“ * + stat_poi += 1;5.結(jié)構(gòu)5.1去掉沒必要的公共變量。說明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少?zèng)]必要的公共變量以降低模塊間的耦合度。5.2仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。說明：在對(duì)變量聲明的同時(shí)，應(yīng)對(duì)其含義、作用及取值范圍進(jìn)行注釋說明，同時(shí)假設(shè)有必要還應(yīng)說明與其它變量的關(guān)系。5.3明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系，如訪

38、問、修改及創(chuàng)立等。說明：明確過程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào) 以及代碼維護(hù)等。這種關(guān)系的說明可在注釋或文檔中描述。例如：在源文件中，可按如下注釋形式說明。RELATION System_lnit lnput_Rec Print_Rec Stat_ScoreStudent CreateModifyAccessAccessScoreCreateModifyAccessAccess, Modify注：RELATION 為操作關(guān)系；Systemnit、Input_Rec、Print_Rec、Stat_Score為四個(gè)不同 的函數(shù)；Student、Score為兩個(gè)全局變

39、量；Create表示創(chuàng)立，Modify表示修改，Access表示訪問。 其中，函數(shù)Input_Rec、Stat_Score都可修改變量 Score,故此變量將引起函數(shù)間較大的耦合 并可能增加代碼測(cè)試、維護(hù)的難度。5.4當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。 說明：對(duì)公共變量賦值時(shí)，假設(shè)有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、 穩(wěn)定性。5.5防止局部變量與公共變量同名。說明：假設(shè)使用了較好的命名規(guī)那么，那么此問題可自動(dòng)消除。5.6嚴(yán)禁使用未經(jīng)初始化的變量作為右值。說明：特別是在C/C+中引用未經(jīng)賦值的指針，經(jīng)常會(huì)引起系統(tǒng)崩潰。1構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改

40、、創(chuàng)立，而其余有關(guān)模塊或函數(shù)只訪問的公共變量防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)立同一公共變量的現(xiàn)象。說明：降低公共變量耦合度。使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)系密切的變量。說明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類型，有利于程序的移植。例如：如下例子(在DOS下BC3.1環(huán)境中),在移植時(shí)可能產(chǎn)生問題。void main()register int index; /存放器變量_AX = 0x4000; / _AX是BC3.1提供的存放器“偽變量./ program code3結(jié)構(gòu)的功能要單一，是針對(duì)一種事務(wù)的抽象。說明：設(shè)計(jì)結(jié)構(gòu)時(shí)應(yīng)力爭(zhēng)使結(jié)構(gòu)代表一種現(xiàn)實(shí)事務(wù)的抽象，而不是

41、同時(shí)代表多種。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。例如：如下結(jié)構(gòu)不太清晰、合理。typedef struct STUDENT_STRUunsigned char name8; /* student's name */unsigned char age;/* student's age */unsigned char sex;/* student's sex, as follows */* 0 - FEMALE; 1 - MALE */unsigned charteacher_name8; /* the s

42、tudent teacher's name */unisgned charteacher_sex;/* his teacher sex */ STUDENT;假設(shè)改為如下，可能更合理些。typedef struct TEACHER_STRU -unsigned char name8; /* teacher name */unisgned char sex;/* teacher sex, as follows */* 0 - FEMALE; 1 - MALE */typedef struct STUDENT_STRU unsigned char name8; unsigned char

43、age; unsigned char sex; TEACHER;/* student's name */* student's age */* student's sex，as follows */* 0 - FEMALE; 1 - MALE */unsigned int STUDENT;teacher_ind; /* his teacher index */4不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)。說明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。那么應(yīng)合為一個(gè)結(jié)構(gòu)。5不同結(jié)構(gòu)間的關(guān)系不要過于復(fù)雜。 說明：假設(shè)兩個(gè)結(jié)構(gòu)間關(guān)系較復(fù)雜、密切 例如：如下兩個(gè)結(jié)構(gòu)的構(gòu)造

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

45、signed char age;unsigned char sex;unsigned char addr40;unsigned char city15; unsigned char tel; PERSON;6結(jié)構(gòu)中元素的個(gè)數(shù)應(yīng)適中。假設(shè)結(jié)構(gòu)中元素個(gè)數(shù)過多可考慮依據(jù)某種原那么把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個(gè)數(shù)。說明：增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。例如：假設(shè)認(rèn)為如上的_PERSON結(jié)構(gòu)元素過多，那么可如下對(duì)之劃分。typedef struct PERSON_BASE_INFO_STRUunsigned char name8;unsigned char age;unsigne

46、d char sex; PERSON_BASE_INFO;typedef struct PERSON_ADDRESS_STRUunsigned char addr40;unsigned char city15;unsigned char tel;PERSON_ADDRESS;typedef struct PERSON_STRUPERSON_BASE_INFO person_base; PERSON_ADDRESS person_addr; PERSON;7仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間 ，并減少引起誤用現(xiàn)象。說明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解

47、性。例如：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。typedef struct EXAMPLE_STRU -unsigned int valid: 1;PERSON person; unsigned int set_flg: 1; EXAMPLE;假設(shè)改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。typedef struct EXAMPLE_STRUunsigned int valid: 1;unsigned int set_flg: 1; PERSON person ; EXAMPLE;8結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級(jí)，并為某些未來可能的應(yīng)用保存余地如預(yù)留一些空

48、間等。說明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標(biāo)志之一。如果要想使產(chǎn)品具 有較好的前向兼容，那么在產(chǎn)品設(shè)計(jì)之初就應(yīng)為以后版本升級(jí)保存一定余地，并且在產(chǎn)品升級(jí)時(shí)必須考慮前一版本的各種特性。9留心具體語言及編譯器處理不同數(shù)據(jù)類型的原那么及有關(guān)細(xì)節(jié)。說明：如在C語言中,static局部變量將在內(nèi)存 數(shù)據(jù)區(qū)中生成,而非static局部變量將 在堆棧中生成。這些細(xì)節(jié)對(duì)程序質(zhì)量的保證非常重要。10編程時(shí)，要注意數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)換。說明：當(dāng)進(jìn)行數(shù)據(jù)類型強(qiáng)制轉(zhuǎn)換時(shí)，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而這些細(xì)節(jié)假設(shè)考慮不周，就很有可能留下隱患。11對(duì)編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的

49、認(rèn)識(shí)。例如：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。 char chr;unsigned short int exam;chr = -1; exam = chr; /編譯器不產(chǎn)生告警，此時(shí)exam為OxFFFF盡量減少?zèng)]有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換。13合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型，防止數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換。/14對(duì)自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一。說明：使用自定義類型，可以彌補(bǔ)編程語言提供類型少、信息量缺乏的缺點(diǎn)，并能使程序清晰、簡(jiǎn)潔。例如：可參考如下方式聲明自定義數(shù)據(jù)類型。下面的聲明可使數(shù)據(jù)

50、類型的使用簡(jiǎn)潔、明了。typedef unsigned char BYTE;typedef unsigned short WORD;typedef unsigned intDWORD;下面的聲明可使數(shù)據(jù)類型具有更豐富的含義。typedef float DISTANCE;typedef float SCORE;15當(dāng)聲明用于分布式環(huán)境或不同CPU間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時(shí)，必須考慮機(jī)器的字節(jié)順序、使用的位域及字節(jié)對(duì)齊等問題。說明：比方In tel CPU與68360 CPU,在處理位域及整數(shù)時(shí)，其在內(nèi)存存放的“順序正 好相反。例如:假設(shè)有如下短整數(shù)及結(jié)構(gòu)。unsigned short int exa

51、m;typedef struct EXAM_BIT_STRU/* Intel 68360 */unsigned int A1: 1; /* bit07*/unsigned int A2: 1; /* bit16*/unsigned int A3: 1; /* bit25*/ EXAM_BIT;如下是In tel CPU生成短整數(shù)及位域的方式。內(nèi)存：012 .從低到高，以字節(jié)為單位exam exam 低字節(jié) exam高字節(jié)內(nèi)存：0 bit 1 bit 2 bit .字節(jié)的各“位EXAM_BIT A1 A2 A3如下是68360 CPU生成短整數(shù)及位域的方式。內(nèi)存：012 .從低到高，以字節(jié)為單位

52、exam exam 高字節(jié) exam低字節(jié)內(nèi)存：7 bit 6 bit 5 bit .字節(jié)的各“位EXAM_BIT A1 A2 A3說明：在對(duì)齊方式下，CPU的運(yùn)行效率要快得多。例如：如以下圖，當(dāng)一個(gè)long型數(shù)如圖中Iong1在內(nèi)存中的位置正好與內(nèi)存的字邊界對(duì) 齊時(shí),CPU存取這個(gè)數(shù)只需訪問一次內(nèi)存，而當(dāng)一個(gè)long型數(shù)如圖中的Iong2在內(nèi)存中的位置跨越了字邊界時(shí)，CPU存取這個(gè)數(shù)就需要屢次訪問內(nèi)存，如i960cx訪問這樣的數(shù)需讀內(nèi)存三次一個(gè)BYTE、一個(gè)SHORT、一個(gè)BYTE，由CPU的微代碼執(zhí)行，對(duì)軟件透明，所有對(duì) 齊方式下CPU的運(yùn)行效率明顯快多了。0108162432| Iong

53、1 | Iong1 | Iong1 | Iong1 |I I I I Iong2 |I Iong2 | Iong2 | Iong2 |I . I6.函數(shù)、過程16-1 :對(duì)所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理 16-2 :明確函數(shù)功能，精確而不是近似地實(shí)現(xiàn)函數(shù)設(shè)計(jì)16-3 :編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用如編寫C/C+語言的可重入函數(shù)時(shí)，應(yīng) 使用auto即缺省態(tài)局部變量或存放器變量說明：編寫C/C+語言的可重入函數(shù)時(shí)，不應(yīng)使用static局部變量，否那么必須經(jīng)過特殊處理， 才能使函數(shù)具有可重入性。16-4 :編寫可重入函數(shù)時(shí)，假設(shè)使用全局變量，那么應(yīng)通過關(guān)中斷、信號(hào)量即P、V操作等

54、手段 對(duì)其加以保護(hù)說明：假設(shè)對(duì)所使用的全局變量不加以保護(hù)，那么此函數(shù)就不具有可重入性，即當(dāng)多個(gè)進(jìn)程調(diào)用此函數(shù)時(shí)，很有可能使有關(guān)全局變量變?yōu)椴豢芍獱顟B(tài)。例如：假設(shè)Exam是int型全局變量，函數(shù)Squre_Exam返回Exam平方值。那么如下函數(shù)不 具有可重入性。un sig ned int exampIe int para un sig ned int temp;Exam = para; / (*)temp = Square_Exam( );return temp;此函數(shù)假設(shè)被多個(gè)進(jìn)程調(diào)用的話 , 其結(jié)果可能是未知的 , 因?yàn)楫?dāng) (*) 語句剛執(zhí)行完后 , 另外一 個(gè)使用本函數(shù)的進(jìn)程可能正好被激活 , 那么當(dāng)新激活的進(jìn)程執(zhí)行到此函數(shù)時(shí) , 將使 Exam 賦 與另一個(gè)不同的para值，所以當(dāng)控制重新回到“temp= Square_Exam()"后，計(jì)算出的temp很可能不是預(yù)想中的結(jié)果。此函數(shù)應(yīng)如下改良。