




版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)
文檔簡(jiǎn)介
1、目 錄1 排版62 注釋113 標(biāo)識(shí)符命名184 可讀性205 變量、結(jié)構(gòu)226 函數(shù)、過程287 可測(cè)性368 程序效率409 質(zhì)量保證4410 代碼編輯、編譯、審查5011 代碼測(cè)試、維護(hù)5212 宏531 排版 1-1:程序塊要采用縮進(jìn)風(fēng)格編寫,縮進(jìn)的空格數(shù)為4個(gè)。說明:對(duì)于由開發(fā)工具自動(dòng)生成的代碼可以有不一致。 1-2:相對(duì)獨(dú)立的程序塊之間、變量說明之后必須加空行。示例:如下例子不符合規(guī)范。if (!valid_ni(ni) . / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex
2、.ni;應(yīng)如下書寫if (!valid_ni(ni) . / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni; 1-3:較長的語句(80字符)要分成多行書寫,長表達(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_tablefr
3、ame_id * stat_task_check_number + index.occupied = stat_poiindex.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)、
4、判斷等語句中若有較長的表達(dá)式或語句,則要進(jìn)行適應(yīng)的劃分,長表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行,操作符放在新行之首。示例:if (taskno max_act_task_number) & (n7stat_stat_item_valid (stat_item) . / program codefor (i = 0, j = 0; (i bufferkeywordword_index.word_length) & (j newkeyword.word_length); i+, j+) . / program codefor (i = 0, j = 0; (i first_word_length)
5、& (j ),后不應(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)志了。在長語句中,如果需要加的空格非常多,那么應(yīng)該保持整體清晰,而在局部不加空格。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。示例:(1) 逗號(hào)、分號(hào)只在后面加空格。int a, b, c; (2)比較操作符, 賦值操作符=、 +=,算術(shù)操作符+、%,邏輯操作符&、&,位域操作符= max_time_valu
6、e) a = b + c;a *= 2;a = b 2;(3)!、+、-、&(地址運(yùn)算符)等單目操作符前后不加空格。*p = a; / 內(nèi)容操作*與內(nèi)容之間flag = !isempty; / 非操作!與內(nèi)容之間p = &mem; / 地址操作& 與內(nèi)容之間i+; / +,-與內(nèi)容之間(4)-、.前后不加空格。p-id = pid; / -指針前后不加空格(5) if、for、while、switch等與后面的括號(hào)間應(yīng)加空格,使if等關(guān)鍵字更為突出、明顯。if (a = b & c d) 1-1:一行程序以小于80字符為宜,不要寫得過長。僅供內(nèi)部使用72 注釋 2-1:一般情況下,源程序有效注
7、釋量必須在20以上。說明:注釋的原則是有助于對(duì)程序的閱讀理解,在該加的地方都加了,注釋不宜太多也不能太少,注釋語言必須準(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)。/* copyright (c), 1988-1999, huawei tech. co., ltd. file name: / 文件名 a
8、uthor: version: date: / 作者、版本及完成日期 description: / 用于詳細(xì)說明此程序文件完成的主要功能,與其他模塊 / 或函數(shù)的接口,輸出值、取值范圍、含義及參數(shù)間的控 / 制、順序、獨(dú)立或依賴等關(guān)系 others: / 其它內(nèi)容的說明 function list: / 主要函數(shù)列表,每條記錄應(yīng)包括函數(shù)名及功能簡(jiǎn)要說明 1. . history: / 修改歷史記錄列表,每條修改記錄應(yīng)包括修改日期、修改 / 者及修改內(nèi)容簡(jiǎn)述 1. date: author: modification: 2. .*/ 2-3:源文件頭部應(yīng)進(jìn)行注釋,列出:版權(quán)說明、版本號(hào)、生成日期
9、、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例:下面這段源文件的頭注釋比較標(biāo)準(zhǔn),當(dāng)然,并不局限于此格式,但上述信息建議要包含在內(nèi)。/* copyright (c), 1988-1999, huawei 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 */說明:descrip
10、tion一項(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ù)清單 called by: / 調(diào)用本函數(shù)的函數(shù)清單 table accessed: / 被訪問的表(此項(xiàng)僅對(duì)于牽
11、扯到數(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ò)誤的注釋不但無益反而有害。規(guī)則2-7:避免在注釋中使用縮寫,特別是非常用縮寫。說明:在使用縮寫時(shí)或之前,應(yīng)對(duì)縮寫進(jìn)行必要的說明。 2
12、-8:注釋應(yīng)與其描述的代碼相近,對(duì)代碼的注釋應(yīng)放在其上方或右方(對(duì)單條語句的注釋)相鄰位置,不可放在下面,如放于上方則需與其上面的代碼用空行隔開。示例:如下例子不符合規(guī)范。例1:/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;例2:repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate
13、 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í)都必須加以注釋,說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。示例:/* active statistic task number */#define max_act_ta
14、sk_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 interface with sccp user primitive message name */enum sccp_user_primitive n_unitdata_ind, /* s
15、ccp 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 data transmission request*/; 2-11:全局變量要有較詳細(xì)的注釋,包括對(duì)其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)注意事項(xiàng)等的說明。示例:/* the errorcode when sccp translate */* globa
16、l 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; 2-12
17、:注釋與所描述內(nèi)容進(jìn)行同樣的縮排。說明:可使程序排版整齊,并方便注釋的閱讀與理解。示例:如下例子,排版不整齊,閱讀稍感不方便。void example_fun( void )/* code one comments */ codeblock one /* code two comments */ codeblock two應(yīng)改為如下布局。void example_fun( void ) /* code one comments */ codeblock one /* code two comments */ codeblock two 2-13:將注釋與其上面的代碼用空行隔開。示例:如下例子,
18、顯得代碼過于緊湊。/* 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 two 2-14:對(duì)變量的定義和分支語句(條件分支、循環(huán)語句等)必須編寫注釋。說明:這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵,對(duì)于維護(hù)人員來說,良好的注釋幫助更好的理解程序,有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。 2-15:對(duì)于switch語句下的case語句,如果因?yàn)樘厥馇闆r需
19、要處理完一個(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 (.) . break;else processcfw_b(); / now jump into case cmd_acase cmd_a: processa(); break;case cmd_b
20、: processb(); break;case cmd_c: processc(); break;case cmd_d: processd(); break;. 2-1:避免在一行代碼或表達(dá)式的中間插入注釋。說明:除非必要,不應(yīng)在代碼或表達(dá)中間插入注釋,否則容易使代碼可理解性變差。 2-2:通過對(duì)函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu),使代碼成為自注釋的。說明:清晰準(zhǔn)確的函數(shù)、變量等的命名,可增加代碼可讀性,并減少不必要的注釋。 2-3:在代碼的功能、意圖層次上進(jìn)行注釋,提供有用、額外的信息。說明:注釋的目的是解釋代碼的目的、功能和采用的方法,提供代碼以外的信息,幫助讀者
21、理解代碼,防止沒必要的重復(fù)注釋信息。示例:如下注釋意義不大。/* if receive_flag is true */if (receive_flag)而如下的注釋則給出了額外有用的信息。 /* if mtp receive a message from links */if (receive_flag) 2-4:在程序塊的結(jié)束行右方加注釋標(biāo)記,以表明某程序塊的結(jié)束。說明:當(dāng)代碼段較長,特別是多重嵌套時(shí),這樣做可以使代碼更清晰,更便于閱讀。示例:參見如下例子。if (.) / program code while (index max_index) / program code /* end
22、of while (index max_index) */ / 指明該條while語句結(jié)束 /* end of if (.)*/ / 指明是哪條if語句結(jié)束 2-5:注釋格式盡量統(tǒng)一,建議使用“/* */”。 2-6:注釋應(yīng)考慮程序易讀及外觀排版的因素,使用的語言若是中、英兼有的,建議多使用中文,除非能用非常流利準(zhǔn)確的英文表達(dá)。說明:注釋語言不統(tǒng)一,影響程序易讀性和外觀排版,出于對(duì)維護(hù)人員的考慮,建議使用中文。僅供內(nèi)部使用153 標(biāo)識(shí)符命名 3-1:標(biāo)識(shí)符的命名要清晰、明了,有明確含義,同時(shí)使用完整的單詞或大家基本可以理解的縮寫,避免使人產(chǎn)生誤解。說明:較短的單詞可通過去掉“元音”形成縮寫;較
23、長的單詞可取單詞的頭幾個(gè)字母形成縮寫;一些單詞有大家公認(rèn)的縮寫。示例:如下單詞的縮寫能夠被大家基本認(rèn)可。temp 可縮寫為 tmp ;flag 可縮寫為 flg ;statistic 可縮寫為 stat ;increment 可縮寫為 inc ;message 可縮寫為 msg ; 3-2:命名中若使用特殊約定或縮寫,則要有注釋說明。說明:應(yīng)該在源文件的開始之處,對(duì)文件中所使用的縮寫或約定,特別是特殊的縮寫,進(jìn)行必要的注釋說明。 3-3:自己特有的命名風(fēng)格,要自始至終保持一致,不可來回變化。說明:個(gè)人的命名風(fēng)格,在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則的前提下,才可使用。(即命名規(guī)則中沒有規(guī)定到的地
24、方才可有個(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).)i 數(shù)據(jù)類型(interger)v 變量(variable) (其它:c 常量(const).)width 變量含義這樣可以防
25、止局部變量與全局變量重名。 3-5:命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致,并在同一項(xiàng)目中統(tǒng)一,比如采用unix的全小寫加下劃線的風(fēng)格或大小寫混排的方式,不要使用大小寫與下劃線混排的方式,用作特殊標(biāo)識(shí)如標(biāo)識(shí)成員變量或全局變量的m_和g_,其后加上大小寫混排的方式是允許的。示例: add_user不允許,add_user、adduser、m_adduser允許。 3-1:除非必要,不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符。示例:如下命名,使人產(chǎn)生疑惑。#define _example_0_test_#define _example_1_test_void set_sls00( byte sls );
26、應(yīng)改為有意義的單詞命名#define _example_unit_test_#define _example_assert_test_void set_udt_msg_sls( byte sls ); 3-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-3:用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等。說明:下面是一些在軟件中常用的反義詞組。add / remove begin / end create / destr
27、oy 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 max_sum;int add_user( byte *user_na
28、me );int delete_user( byte *user_name ); 3-4:除了編譯開關(guān)/頭文件等特殊應(yīng)用,應(yīng)避免使用_example_test_之類以下劃線開始和結(jié)尾的定義。 僅供內(nèi)部使用184 可讀性 4-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) & (a & c) (2)if (a | b) (c & d) (3)如果書寫為high 8 | lowa | b & a &
29、ca | b c & d由于high 8 | low = ( high 8) | low,a | b & a & c = (a | b) & (a & c),(1)(2)不會(huì)出錯(cuò),但語句不易理解;a | b c & d = a | (b c) & d,(3)造成了判斷條件出錯(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)改
30、為如下形式。#define trunk_idle 0#define trunk_busy 1if (trunkindex.trunk_state = trunk_idle) trunkindex.trunk_state = trunk_busy; . / program code 4-1:源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。說明:便于程序閱讀和查找。示例:以下代碼布局不太合理。rect.length = 10;char_poi = str;rect.width = 5;若按如下形式書寫,可能更清晰一些。rect.length = 10;rect.width = 5; / 矩形的長與寬關(guān)系較
31、密切,放在一起。char_poi = str; 4-2:不要使用難懂的技巧性很高的語句,除非很有必要時(shí)。說明:高技巧語句不等于高效率的程序,實(shí)際上程序的效率關(guān)鍵在于算法。示例:如下表達(dá)式,考慮不周就可能出問題,也較難理解。* stat_poi + += 1;* + stat_poi += 1;應(yīng)分別改為如下。*stat_poi += 1;stat_poi+; / 此二語句功能相當(dāng)于“ * stat_poi + += 1; ”+ stat_poi;*stat_poi += 1; / 此二語句功能相當(dāng)于“ * + stat_poi += 1; ”僅供內(nèi)部使用205 變量、結(jié)構(gòu) 5-1:去掉沒必要的
32、公共變量。說明:公共變量是增大模塊間耦合的原因之一,故應(yīng)減少?zèng)]必要的公共變量以降低模塊間的耦合度。 5-2:仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。說明:在對(duì)變量聲明的同時(shí),應(yīng)對(duì)其含義、作用及取值范圍進(jìn)行注釋說明,同時(shí)若有必要還應(yīng)說明與其它變量的關(guān)系。 5-3:明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系,如訪問、修改及創(chuàng)建等。說明:明確過程操作變量的關(guān)系后,將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以及代碼維護(hù)等。這種關(guān)系的說明可在注釋或文檔中描述。示例:在源文件中,可按如下注釋形式說明。relation system_init input_rec print_r
33、ec stat_scorestudent create modify access accessscore create modify access access, modify注:relation為操作關(guān)系;system_init、input_rec、print_rec、stat_score為四個(gè)不同的函數(shù);student、score為兩個(gè)全局變量;create表示創(chuàng)建,modify表示修改,access表示訪問。其中,函數(shù)input_rec、stat_score都可修改變量score,故此變量將引起函數(shù)間較大的耦合,并可能增加代碼測(cè)試、維護(hù)的難度。 5-4:當(dāng)向公共變量傳遞數(shù)據(jù)時(shí),要十分小
34、心,防止賦與不合理的值或越界等現(xiàn)象發(fā)生。說明:對(duì)公共變量賦值時(shí),若有必要應(yīng)進(jìn)行合法性檢查,以提高代碼的可靠性、穩(wěn)定性。 5-5:防止局部變量與公共變量同名。說明:若使用了較好的命名規(guī)則,那么此問題可自動(dòng)消除。 5-6:嚴(yán)禁使用未經(jīng)初始化的變量作為右值。說明:特別是在c/c+中引用未經(jīng)賦值的指針,經(jīng)常會(huì)引起系統(tǒng)崩潰。 5-1:構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建,而其余有關(guān)模塊或函數(shù)只訪問的公共變量,防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。說明:降低公共變量耦合度。 5-2:使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型,盡量不要使用與具體硬件或軟件環(huán)境關(guān)系密切的變量。說明:使用標(biāo)準(zhǔn)的數(shù)
35、據(jù)類型,有利于程序的移植。示例:如下例子(在dos下bc3.1環(huán)境中),在移植時(shí)可能產(chǎn)生問題。void main() register int index; / 寄存器變量 _ax = 0x4000; / _ax是bc3.1提供的寄存器“偽變量” . / program code 5-3:結(jié)構(gòu)的功能要單一,是針對(duì)一種事務(wù)的抽象。說明:設(shè)計(jì)結(jié)構(gòu)時(shí)應(yīng)力爭(zhēng)使結(jié)構(gòu)代表一種現(xiàn)實(shí)事務(wù)的抽象,而不是同時(shí)代表多種。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面,而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。示例:如下結(jié)構(gòu)不太清晰、合理。typedef struct student_stru unsig
36、ned 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 */ unisgned char teacher_sex; /* his teacher sex */ student;若改為如下,可能更合理些。typedef struct tea
37、cher_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 age; /* students age */ unsigned char sex; /* students sex, as follows */ /* 0 - fe
38、male; 1 - male */ unsigned int teacher_ind; /* his teacher index */ student; 5-4:不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)。說明:面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。 5-5:不同結(jié)構(gòu)間的關(guān)系不要過于復(fù)雜。說明:若兩個(gè)結(jié)構(gòu)間關(guān)系較復(fù)雜、密切,那么應(yīng)合為一個(gè)結(jié)構(gòu)。示例:如下兩個(gè)結(jié)構(gòu)的構(gòu)造不合理。typedef struct person_one_stru unsigned char name8; unsigned char addr40; unsigned char sex; unsigned char
39、city15; person_one;typedef struct person_two_stru unsigned char name8; unsigned char age; unsigned char tel; person_two;由于兩個(gè)結(jié)構(gòu)都是描述同一事物的,那么不如合成一個(gè)結(jié)構(gòu)。typedef struct person_stru unsigned char name8; unsigned char age; unsigned char sex; unsigned char addr40; unsigned char city15; unsigned char tel; pers
40、on; 5-6:結(jié)構(gòu)中元素的個(gè)數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個(gè)數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu),以減少原結(jié)構(gòu)中元素的個(gè)數(shù)。說明:增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。示例:假如認(rèn)為如上的_person結(jié)構(gòu)元素過多,那么可如下對(duì)之劃分。typedef struct person_base_info_stru unsigned char name8; unsigned char age; unsigned char sex; person_base_info;typedef struct person_address_stru unsigned char addr40; unsigned
41、char city15; unsigned char tel; person_address;typedef struct person_stru person_base_info person_base; person_address person_addr; person; 5-7:仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序,使結(jié)構(gòu)容易理解、節(jié)省占用空間,并減少引起誤用現(xiàn)象。說明:合理排列結(jié)構(gòu)中元素順序,可節(jié)省空間并增加可理解性。示例:如下結(jié)構(gòu)中的位域排列,將占較大空間,可讀性也稍差。typedef struct example_stru unsigned int valid: 1; person
42、 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; 5-8:結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級(jí),并為某些未來可能的應(yīng)用保留余地(如預(yù)留一些空間等)。說明:軟件向前兼容的特性,是軟件產(chǎn)品是否成功的重要標(biāo)志之一。如果要想使產(chǎn)品具有較好的前向兼容,那么在產(chǎn)品設(shè)計(jì)之初就應(yīng)為以后版本升級(jí)保留一定余地,并且在產(chǎn)品
43、升級(jí)時(shí)必須考慮前一版本的各種特性。 5-9:留心具體語言及編譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細(xì)節(jié)。說明:如在c語言中,static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成,而非static局部變量將在“堆?!敝猩伞_@些細(xì)節(jié)對(duì)程序質(zhì)量的保證非常重要。 5-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é)若考慮不周,就很有可能留下隱患。 5-11:對(duì)編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換,也要有充分的認(rèn)識(shí)。示例:如下賦值,多數(shù)編譯器不產(chǎn)生告警,但值的含義還是稍有變化。char chr;unsigned short int exam;ch
44、r = -1;exam = chr; / 編譯器不產(chǎn)生告警,此時(shí)exam為0xffff。 5-12:盡量減少?zèng)]有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換。 5-13:合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型,避免數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換。 5-14:對(duì)自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名,使它成為自描述性的,以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一。說明:使用自定義類型,可以彌補(bǔ)編程語言提供類型少、信息量不足的缺點(diǎn),并能使程序清晰、簡(jiǎn)潔。示例:可參考如下方式聲明自定義數(shù)據(jù)類型。下面的聲明可使數(shù)據(jù)類型的使用簡(jiǎn)潔、明了。typedef unsigned char byte;typedef unsigned short word;typedef unsigned int dword;下面的聲明可使數(shù)據(jù)類型具有更豐富的含義。typedef float distance;typedef float score; 5-15:當(dāng)聲明用于分布式環(huán)境或不同cpu間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時(shí),必須考慮機(jī)器的字節(jié)順序、使用的位域及字節(jié)對(duì)齊等問題 。說明:比如intel cpu與68360 cpu,在處理位域及整數(shù)時(shí),其在內(nèi)存存放的“順序”正好相反。示
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。
最新文檔
- 詳盡多條款單項(xiàng)勞務(wù)分包合同
- 保險(xiǎn)服務(wù)居間合同
- 工業(yè)廠房租賃合同
- 建筑工程款轉(zhuǎn)讓協(xié)議書
- 裝卸運(yùn)輸服務(wù)合同
- 智能科技產(chǎn)品開發(fā)合作合同
- 個(gè)人果樹承包合同
- 管理軟件系統(tǒng)買賣合同書
- 美術(shù)老師教學(xué)成果保護(hù)協(xié)議
- 項(xiàng)目策劃服務(wù)合同
- 2024屆廣東省深圳市中考物理模擬試卷(一模)(附答案)
- 前庭功能鍛煉科普知識(shí)講座
- 信永中和線上測(cè)評(píng)題庫
- 供應(yīng)鏈戰(zhàn)略布局與區(qū)域拓展案例
- 上海話培訓(xùn)課件
- 注塑車間績效考核方案
- 初中英語閱讀理解專項(xiàng)練習(xí)26篇(含答案)
- LS/T 1234-2023植物油儲(chǔ)存品質(zhì)判定規(guī)則
- 如何培養(yǎng)孩子的自主學(xué)習(xí)能力
- 【新能源汽車企業(yè)的財(cái)務(wù)風(fēng)險(xiǎn)控制研究:以比亞迪公司為例15000字】
- 核心素養(yǎng)導(dǎo)向的作業(yè)設(shè)計(jì)
評(píng)論
0/150
提交評(píng)論