黑馬3期ios培訓(xùn)基礎(chǔ)就業(yè)班2014年7月-1204網(wǎng)絡(luò)webview素材編程_第1頁
黑馬3期ios培訓(xùn)基礎(chǔ)就業(yè)班2014年7月-1204網(wǎng)絡(luò)webview素材編程_第2頁
黑馬3期ios培訓(xùn)基礎(chǔ)就業(yè)班2014年7月-1204網(wǎng)絡(luò)webview素材編程_第3頁
黑馬3期ios培訓(xùn)基礎(chǔ)就業(yè)班2014年7月-1204網(wǎng)絡(luò)webview素材編程_第4頁
黑馬3期ios培訓(xùn)基礎(chǔ)就業(yè)班2014年7月-1204網(wǎng)絡(luò)webview素材編程_第5頁
已閱讀5頁,還剩53頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)

文檔簡介

1、目錄61118202228364044505253排版注釋標識符命名可讀性變量、結(jié)構(gòu)函數(shù)、過程可測性程序效率質(zhì)量保證12345678910 代碼編輯、編譯、11 代碼測試、維護12 宏1 排版¹1-1:程序塊要采用縮進風格編寫,縮進的空格數(shù)為4個。說明:對于由開發(fā)工具自動生成的代碼可以有不一致。¹1-2:相對的程序塊之間、變量說明之后必須加空行。示例:如下例子不符合規(guī)范。if (!valid_ni(ni). / program coderepssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni;

2、應(yīng)如下書寫if (!valid_ni(ni). / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;¹1-3:較長的語句(>80字符)要分成多行書寫,長表要在低優(yōu)先級操作符處劃分新行,操作符放在新行之首,劃分出的新行要進行適當?shù)目s進,使排版整齊,語句可讀。示例:perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_tablef

3、rame_id * STAT_TASK_CHECK_NUMBER + index.occupied= stat_poiindex.occupied;act_task_tabletaskno.duration_true_or_false= SYS_get_s_statistic_state( stat_item );report_or_not_flag = (taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item)&& (act_task_tabletaskno.result_da

4、ta != 0);¹1-4:循環(huán)、等語句中若有較長的表或語句,則要進行適應(yīng)的劃分,長表要在低優(yōu)先級操作符處劃分新行,操作符放在新行之首。示例: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

5、 codefor (i =(i < i+,0, j = 0;first_word_length) && (j < second_word_length); j+). / program code¹1-5:若函數(shù)或過程中的參數(shù)較長,則要進行適當?shù)膭澐帧?示例:pare(BYTE *) & stat_object,(BYTE *) & (act_task_tabletaskno.stat_object), sizeof (_STAT_OBJECT);n7stat_flash_act_duration( stat_item, frame_id *

6、STAT_TASK_CHECK_NUMBER+ index, stat_object );¹1-6:不把多個短語句寫在一行中,即一行只寫一條語句。示例:如下例子不符合規(guī)范。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í)行語句部分無論多少都要加括號。示例:如下例子不符合規(guī)范。if (pUserCR = NULL) return;應(yīng)如下書寫:if (pU

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

8、義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進方式。 示例:如下例子不符合規(guī)范。for (.) . / program codeif (.). / program codevoid example_fun( void ). / programcode應(yīng)如下書寫。for (.). / programcodeif (.). / programcodevoid example_fun(void ). / program code¹1-11:在兩個以上的、變量、常量進行對等操作時,它們之間的操作符之前、之后或者前后要加空格;進行非對等操

9、作時,如果是切的立即操作符(如>),后不應(yīng)加空格。說明:采用這種松散方式編寫代碼的目的是使代碼更加清晰。由于所產(chǎn)生的清晰性是相對的,所以,在已經(jīng)非常清晰的語句中沒有必要再,如果語句已足夠清晰則括號內(nèi)側(cè)(即左括號后面和右括號前面)不需要加空格,多重括號間不必加空格,因為在 C/C+語言中括號已經(jīng)是最清晰的標志了。在長語句中,如果需要加的空格非常多,那么應(yīng)該保持整體清晰,而在局部不加空格。給操作符時不要連續(xù)留兩個以上空格。示例:(1) 逗號、分號只在后面加空格。int a, b, c;(2)比較操作符, 賦值操作符"="、 "+=",算術(shù)操作符&quo

10、t;+"、"%",邏輯操作符"&&"、"&",位域操作符"<<"、""等雙目操作符的前后加空格。if (current_time >= MAX_TIME_VALUE)aa a= b + c;*= 2;= b 2;(3)"!"、""、"+"、"-"、"&"(地址運算符)等單目操作符前后不加空格。*p = 'a'/ 內(nèi)容操作&

11、quot;*"與內(nèi)容之間flag = !isEmpty; / 非操作"!"與內(nèi)容之間p = &mem;i+;/ 地址操作"&" 與內(nèi)容之間/ "+","-"與內(nèi)容之間(4)"->"、"."前后不加空格。/ "->"指針前后不加空格p->id = pid;(5) if、for、while、switch 等與后面的括號間應(yīng)加空格,使 if 等明顯。if (a >= b && c > d)更

12、為突出、½1-1:一行程序以小于80字符為宜,不要寫得過長。2 注釋¹2-1:一般情況下,源程序有效注釋量必須在20以上。說明:注釋的原則是有助于對程序的閱讀理解,在該加的地方都加了,注釋不宜太多也不能太少,注釋語言必須準確、易懂、簡潔。¹2-2:說明性文件(如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等)頭部應(yīng)進行注釋,注釋必須列權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等,頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明。示例:下面這段頭文件的頭注釋比較標準,當然,并不局限于此格式,但上述信息建議要包含在內(nèi)。/*Copyr

13、ight (C), 1988-1999,Tech. Co.,./ 文件名Version:File name: Author:Description:Date: / 作者、版本及完成日期/ 用于詳細說明此程序文件完成的主要功能,與其他模塊/ 或函數(shù)的接口,輸出值、取值范圍、含義及參數(shù)間的控/ 制、順序、或依賴等關(guān)系Others:/ 其它內(nèi)容的說明Function List: / 主要函數(shù)列表,每條1. .應(yīng)包括函數(shù)名及功能簡要說明History:/ 修改歷史列表,每條修改應(yīng)包括修改日期、修改/ 者及修改內(nèi)容簡述1. Date:Author:Modification: 2. .*/¹2-

14、3:源文件頭部注釋,列權(quán)說明、版本號、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例:下面這段源文件的頭注釋比較標準,當然,并不局限于此格式,但上述信息建議要包含在內(nèi)。/*CopyrightFileName: Author:(C), 1988-1999,test.cppVersion :Tech. Co.,.Date:Description:Version:/ 模塊描述/ 版本信息/ 主要函數(shù)及其功能FunctionList:1./ 歷史修改History:<author> <time> <version ><desc>Dav

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

16、ble Accessed: / 被的表(此項僅對于牽扯到數(shù)據(jù)庫操作的程序)Table Updated: / 被修改的表(此項僅對于牽扯到數(shù)據(jù)庫操作的程序)/ 輸入?yún)?shù)說明,包括每個參數(shù)的作/ 用、取值說明及參數(shù)間關(guān)系。Input:Output: Return:Others:/對輸出參數(shù)的說明。函數(shù)返回值的說明其它說明*/¹2-5:邊寫代碼邊注釋,修改代碼同時修改相應(yīng)的注釋,以保證注釋與代碼的一致性。不再有用的注釋要刪除。¹2-6:注釋的內(nèi)容要清楚、明了,含義準確,防止注釋二義性。說明:錯誤的注釋不但無益反而有害。規(guī)則2-7:避免在注釋中使用縮寫,特別是非常用縮寫。說明:在使

17、用縮寫時或之前,應(yīng)對縮寫進行必要的說明。¹2-8:注釋應(yīng)與其描述的代碼相近,對代碼的注釋應(yīng)放在其上方或右方(對單條語句的注釋)相鄰位置,不可放在下面,如放于上方則需與其上面的代碼用空行隔開。示例:如下例子不符合規(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_

18、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:對于所有有物理含義的變量、常量,如果其命名不是充分自注釋的,在以注釋,說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。時都必須加示例:/* active statistik

19、number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistik number */¹2-10:數(shù)據(jù)結(jié)構(gòu)(包括數(shù)組、結(jié)構(gòu)、類、枚舉等),如果其命名不是充分自注釋的,必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置,不可放在下面;對結(jié)構(gòu)中的每個域的注在此域的右方。示例:可按如下形式說明枚舉/數(shù)據(jù)/結(jié)構(gòu)。/* s enum Sinterface with s_USER_PRIMITIVEuser primitive message name */N_UNITDATA

20、_IND, /* snotify suser unit data come */N_NOTICE_IND,/* snotify user the No.7 network can not */* transmission this message */N_UNITDATA_REQ, /* suser's unit data transmission request*/;¹2-11:全局變量要有較詳細的注釋,包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。示例:/*/*/*/*/*/*/*/*The ErrorCode when Stranslate *

21、/Global Title failure, as follows */0 SUCCESS 1 GT Table error */ 2 GT error Others no use */ 變量作用、含義/ 變量取值范圍only function STranslate() in */this modual can modify it, and other module can visit it through call */the function GetGTTransErrorCode() */*/ 使用方法BYTE g_GTTranErrorCode;¹2-12:注釋與所描述內(nèi)容進

22、行同樣的縮排。說明:可使程序排版整齊,并方便注釋的閱讀與理解。示例:如下例子,排版不整齊,閱讀稍感不方便。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:將注釋與其上面的代碼用空行隔開。示例:如下例子,顯得代碼過于緊湊。/

23、* code program/* codeprogramone comments code one two commentscode two*/*/應(yīng)如下書寫/* codeprogramone commentscode one*/* codeprogramtwo commentscode two*/¹2-14:對變量的分支語句(條件分支、循環(huán)語句等)必須編寫注釋。說明:這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵,對于維護來說,良好的注釋幫助更好的理解程序,有時甚至優(yōu)于看設(shè)計文檔。¹2-15:對于switch語句下的case語句,如果因為特殊情況需要處理完一個case后進入下一

24、 個case處理,必須在該case語句處理完、下一個case語句前加上明確的注釋。說明:這樣比較清楚程序編寫者的意圖,有效防止無故遺漏 break 語句。示例(注意斜體加粗部分):case CMD_UP:ProcessUp();break;case CMD_DOWN: ProcessDown();break;case CMD_FWD:ProcessFwd();if (.).break;elseProcessCFW_B();/nowjumpintocaseCMD_Acase CMD_A:ProcessA(); break;case CMD_B:ProcessB(); break;case CMD

25、_C:ProcessC(); break;case CMD_D:ProcessD(); break;.½2-1:避免在一行代碼或表的中間注釋。說明:除非必要,不應(yīng)在代碼或表達中間注釋,否則容易使代碼可理解性變差。½2-2:通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確自注釋的。名以及合理地組織代碼的結(jié)構(gòu),使代碼成為說明:清晰準確的函數(shù)、變量等名,可增加代碼可讀性,并減少不必要的注釋。½2-3:在代碼的功能、意圖層次上進行注釋,提供有用、額外的信息。說明:注釋的目的是解釋代碼的目的、功能和采用的方法,提供代碼以外的信息,幫助讀者理解代碼,防止沒必要的重復(fù)注釋信息。示例:如下注釋

26、意義不大。/* if receive_flag is TRUE */ if (receive_flag)而如下的注釋則給出了額外有用的信息。/* if mtp receive a message from links */ if (receive_flag)½2-4:在程序塊的結(jié)束行右方加注釋標記,以表明某程序塊的結(jié)束。說明:當代碼段較長,特別是多重嵌套時,這樣做可以使代碼更清晰,更便于閱讀。示例:參見如下例子。if (.)/ program codewhile (index < MAX_INDEX)/ program code /* end of while (index &

27、lt; MAX_INDEX) */ / 指明該條 while 語句結(jié)束 /* end of if (.)*/ / 指明是哪條 if 語句結(jié)束½2-5:注釋格式盡量統(tǒng)議使用“/* */”。½2-6:注釋應(yīng)考慮程序易讀及外觀排版的因素,使用的語言若是中、英兼有的,建議多使用中文,除非能用非常流利準確的英文表達。說明:注釋語言不統(tǒng)一,影響程序易讀性和外觀排版,出于對維護的考慮,建議使用中文。3 標識符命名¹3-1:標識符名要清晰、明了,有明確含義,同時使用完整的單詞或大家基本可以理解的縮寫,避免使人產(chǎn)生誤解。說明:較短的單詞可通過去掉“元音”形成縮寫;較長的單詞可取單詞

28、的頭幾個字母形成縮寫;一些單詞有大家公認的縮寫。示例:如下單詞的縮寫能夠被大家基本認可。temp 可縮寫為 tmp flag 可縮寫為statistic 可縮寫為increment 可縮寫為;stat ; inc ;message 可縮寫為 msg ;¹3-2:命名中若使用特殊約定或縮寫,則要有注釋說明。說明:應(yīng)該在源文件的開始之處,對文件中所使用的縮寫或約定,特別是特殊的縮寫,進行必要的注釋說明。¹3-3:特有名風格,要自始至終保持一致,不可來回變化。說明:個人名風格,在符合所在項目組或組名規(guī)則的前提下,使用。(即命名規(guī)則中沒有規(guī)定到的地方有個人命名風格)。¹3

29、-4:對于變量命名,取單個字符(如i、j、k.),建議除了要有具體含義外,還能表明其變量類型、數(shù)據(jù)類型等,但i、j、k作局部循環(huán)變量是的。說明:變量,尤其是局部變量,如果用單個字符表示,很容易敲錯(如 i 寫成 j),而編譯檢查不出來,有可能為了這個小小的錯誤而花費大量的查錯時間。示例:下面所示的局部變量名的定義方法可以借鑒。int liv_Width其變量名解釋如下:局部變量(Local) (其它:g數(shù)據(jù)類型(Interger)全局變量(Global).)l i vWidth變量(Variable)變量含義(其它:c常量(Const).)這樣可以防止局部變量與全局變量重名。¹3-5

30、:命名規(guī)范必須與所使用的系統(tǒng)風格保持一致,并在同一項目中統(tǒng)一,比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式,不要使用大小寫與下劃線混排的方式,用作特殊標識如標識成員變量或全局變量的m_和g_,其后加上大小寫混排的方式是的。示例: Add_User 不,add_user、AddUser、m_AddUser。½3-1:除非必要,不要用數(shù)字或較奇怪的字符來定義標識符。示例:如下命名,使人產(chǎn)生疑惑。#define _EXAMPLE_0_TEST_ #define _EXAMPLE_1_TEST_void set_sls00( BYTE sls );應(yīng)改為有意義的單詞命名#defi

31、ne _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls );½3-2:在同一軟件內(nèi),應(yīng)好接口部分標識符(變量、結(jié)構(gòu)、函數(shù)及常量)名,防止編譯、時產(chǎn)生。說明:對接口部分的標識符應(yīng)該有更嚴格限制,防止。如可規(guī)定接口部分的變量與常量之前加上“模塊”標識等。½3-3:用正確的反義詞組命名具有互斥意義的變量或相說明:下面是一些在軟件中常用的反義詞組。作的函數(shù)等。add / removeinsert / deletebegin / endfirst / lastcreate /

32、 destroy get / releaseput / get open / closestart / stopshow / hideincrement / decrementadd / delete min / maxnext / previous send / receive cut / paste示例:lock / unlockold / newsource / source /up / downtargetdestinationintint intmin_sum; max_sum;add_user( BYTE *user_name );int delete_user( BYTE *us

33、er_name );½3-4:除了編譯開關(guān)/頭文件等特殊應(yīng)用,應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義。4 可讀性¹4-1:注意運算符的優(yōu)先級,并用括號明確表的操作順序,避免使用默認優(yōu)先級。說明:防止閱讀程序時產(chǎn)生誤解,防止因默認的優(yōu)先級與設(shè)計思想不符而導(dǎo)致程序出錯。示例:下列語句中的表word = if (aif (a(high << 8) | low(1)(2)(3)| b)| b)&& (a & c)< (c & d)如果書寫為high << 8 |lowa | b &&a

34、mp; a & c a | b < c & d 由于high << 8 | low = ( higha | b && a & c = (a | b)<< 8)&& (a| low,& c),(1)(2)出錯,但語句不易理解;a | b < c & d = a | (b < c) &d,(3)造成了條件出錯。¹4-2:避免使用不易理解的數(shù)字,用有意義的標識來替代。涉及物理狀態(tài)或者含有物理意義的常量,不應(yīng)直接使用數(shù)字,必須用有意義的枚舉或宏來代替。示例:如下的程序可讀

35、性差。if (Trunkindex.trunk_state = 0)Trunkindex.trunk_state = 1;. / programcode應(yīng)改為如下形式。#define TRUNK_IDLE #define TRUNK_BUSY01if (Trunkindex.trunk_state = TRUNK_IDLE)Trunkindex.trunk_state = TRUNK_BUSY;. / program code½4-1:源關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。說明:便于程序閱讀和查找。示例:以下代碼布局不太合理。rect.length = 10; char_poi = st

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

37、;*stat_poi +=1; / 此二語句功能相當于“ * + stat_poi += 1; ”5 變量、結(jié)構(gòu)¹5-1:去掉沒必要的公共變量。說明:公共變量是增大模塊間耦合的之一,故應(yīng)減少沒必要的公共變量以降低模塊間的耦合度。¹5-2:仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。說明:在對變量的同時,應(yīng)對其含義、作用及取值范圍進行注釋說明,同時若有必要還應(yīng)說明與其它變量的關(guān)系。¹5-3:明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系,如、修改及創(chuàng)建等。說明:明確過程操作變量的關(guān)系后,將有利于程序的進一步優(yōu)化、單元測試、系統(tǒng)聯(lián)調(diào)以及代碼維護等。

38、這種關(guān)系的說明可在注釋或文檔中描述。示例:在源文件中,可按如下注釋形式說明。RELATIONStudent ScoreSystem_Init CreateCreateInput_Rec ModifyModifyPrint_Rec AccessAccessStat_Score AccessAccess, Modify注:RELATION 為操作關(guān)系;System_Init、Input_Rec、Print_Rec、Stat_Score為四個不同的函數(shù);Student、Score 為兩個全局變量;Create 表示創(chuàng)建,Modify 表示修改,Access 表示。其中,函數(shù) Input_Rec、St

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

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

41、同側(cè)面,而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。示例:如下結(jié)構(gòu)不太清晰、合理。typedef struct STUDENT_STRUunsignedunsigned unsignedcharchar charname8; /* student's name */age;sex;/* student's age */* student's sex, as follows */* 0 - FEMALE; 1 - MALE */unsignedcharteacher_name8; /* the student teacher's name */u

42、nisgned charteacher_sex; STUDENT;/* his teacher sex */若改為如下,可能更合理些。typedef struct TEACHER_STRUunsigned char name8; /* teacher name */unisgned char sex;/* teacher sex, as follows */* 0 - FEMALE; 1 - MALE */ TEACHER;typedef struct STUDENT_STRUunsigned unsignedunsignedchar charcharname8; age;sex;/* stu

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

44、signed unsigned unsignedunsignedchar char charcharname8;addr40;sex; city15;_ONE;typedef struct_TWO_STRUunsigned unsignedunsignedchar charcharname8; age;tel;_TWO;由于兩個結(jié)構(gòu)都是描述同一事物的,那么不如一個結(jié)構(gòu)。typedef struct_STRUunsigned unsigned unsigned unsigned unsigned unsigned;char char char char charcharname8; age; s

45、ex;addr40;city15; tel;½5-6:結(jié)構(gòu)中元素的個數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu),以減少原結(jié)構(gòu)中元素的個數(shù)。說明:增加結(jié)構(gòu)的可理解性、可操作性和可維護性。示例:假如認為如上的_ typedef struct結(jié)構(gòu)元素過多,那么可如下對之劃分。_BASE_INFO_STRUunsigned unsignedunsignedchar charcharname8; age;sex;_BASE_INFO;typedef struct_ADDRESS_STRUunsignedunsigned unsignedcharchar charad

46、dr40;city15; tel;_ADDRESS;typedefstruct_STRU_BASE_INFO_ADDRESS_base;_addr;½5-7:仔細設(shè)計結(jié)構(gòu)中元素的布局與排列順序,使結(jié)構(gòu)容易理解、節(jié)省占用空間,并減少引起誤用現(xiàn)象。說明:合理排列結(jié)構(gòu)中元素順序,可節(jié)省空間并增加可理解性。示例:如下結(jié)構(gòu)中的位域排列,將占較大空間,可讀性也稍差。typedef struct EXAMPLE_STRUunsigned int valid: 1;unsigned int set_ EXAMPLE;: 1;若改成如下形式,不僅可節(jié)省 1 字節(jié)空間,可讀性也變好了。typedef s

47、truct EXAMPLE_STRUunsigned int valid: 1;unsigned int set_; EXAMPLE;: 1;½5-8:結(jié)構(gòu)的設(shè)計要盡量考慮向前兼容和以后的版本升級,并為某些未來可能的應(yīng)用保留余地(如預(yù)留一些空間等)。說明:軟件向前兼容的特性,是軟件是否的重要標志之一。如果要想使具有較好的前向兼容,那么在設(shè)計之應(yīng)為以后版本升級保留一定余地,并且在升級時必須考慮前一版本的各種特性。½5-9:留心具體語言及編譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細節(jié)。說明:如在 C 語言中,static 局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成,而非 static 局部變量將

48、在“堆棧”中生成。這些細節(jié)對程序質(zhì)量的保證非常重要。½5-10:編程時,要注意數(shù)據(jù)類型的強制轉(zhuǎn)換。說明:當進行數(shù)據(jù)類型強制轉(zhuǎn)換時,其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化,而這些細節(jié)若考慮不周,就很有可能留下隱患。½5-11:對編譯系統(tǒng)默認的數(shù)據(jù)類型轉(zhuǎn)換,也要有充分的認識。示例:如下賦值,多數(shù)編譯器不產(chǎn)生告警,但值的含義還是稍有變化。char chr;unsigned short int exam;chr = -1;exam = chr; / 編譯器不產(chǎn)生告警,此時 exam 為 0xFFFF。½5-12:盡量減少沒有必要的數(shù)據(jù)類型默認轉(zhuǎn)換與強制轉(zhuǎn)換。

49、9;5-13:合理地設(shè)計數(shù)據(jù)并使用自定義數(shù)據(jù)類型,避免數(shù)據(jù)間進行不必要的類型轉(zhuǎn)換。½5-14:對自定義數(shù)據(jù)類型進行恰當命名,使它成為自描述性的,以提高代碼可讀性。注意其命名方式在同一中的統(tǒng)一。說明:使用自定義類型,可以彌補編程語言提供類型少、信息量不足的缺點,并能使程序清晰、簡潔。示例:可參考如下方式自定義數(shù)據(jù)類型。下面的typedef typedeftypedef可使數(shù)據(jù)類型的使用簡潔、明了。unsigned unsignedunsignedchar BYTE;short WORD;intDWORD;下面的typedef typedef可使數(shù)據(jù)類型具有更豐富的含義。float DI

50、STANCE; float SCORE;½5-15:當用于分布式環(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 typedef structint exam;EXAM_BIT_STRU/* 1;1;1;Intel 68360*/765unsignedunsigned unsignedintint intA1:A2:A3:/*/*/*bitbit bit012*/*/*/ EXAM_

51、BIT;如下是 Intel CPU 生成短整數(shù)及位域的方式。內(nèi)存: 012. (從低到高,以字節(jié)為)exam exam 低字節(jié) exam 高字節(jié)內(nèi)存:EXAM_BIT0 bitA11 bitA22 bitA3. (字節(jié)的各“位”)如下是 68360內(nèi)存: 0CPU 生成短整數(shù)及位域的方式。. (從低到高,以字節(jié)為)12exam exam 高字節(jié) exam 低字節(jié)內(nèi)存:EXAM_BIT. (字節(jié)的各“位”)7 bitA16 bitA25 bitA3說明:在對齊方式下,CPU 的運行效率要快得多。示例:如下圖,當一個 long 型數(shù)(如圖中 long1)在內(nèi)存中的位置正好與內(nèi)存的字邊界對,CPU

52、存取這個數(shù)只需一次內(nèi)存,而當一個 long 型數(shù)(如圖中的 long2)在內(nèi)存中的位置了字邊界時,CPU 存取這個數(shù)就需要多次內(nèi)存,如 i960cx這樣的數(shù)需讀內(nèi)存三次(一個 BYTE、一個 SHORT、一個 BYTE,由 CPU 的微代碼執(zhí)行,對軟件透明),所有對齊方式下 CPU 的運行效率明顯快多了。18162432|long1 |long1|long1 | long1 | long2 |long2 |long2|long2 |.6 函數(shù)、過程¹6-1:對所調(diào)用函數(shù)的錯誤返回碼要仔細、全面地處理。¹6-2:明確函數(shù)功能,精確(而不是近似)地實現(xiàn)函數(shù)設(shè)計。¹6-

53、3:編寫可重入函數(shù)時,應(yīng)注意局部變量的使用(如編寫C/C+語言的可重入函數(shù)時,應(yīng)使 用auto即缺省態(tài)局部變量或寄存器變量)。說明:編寫 C/C+語言的可重入函數(shù)時,不應(yīng)使用 static 局部變量,否則必須經(jīng)過特殊處理,才能使函數(shù)具有可重入性。¹6-4:編寫可重入函數(shù)時,若使用全局變量,則應(yīng)通過關(guān)中斷、信號量(即P、V操作)等對其加以保護。說明:若對所使用的全局變量不加以保護,則此函數(shù)就不具有可重入性,即當多個進程調(diào)用此函數(shù)時,很有可能使有關(guān)全局變量變?yōu)椴豢芍獱顟B(tài)。示例:假設(shè) Exam 是 int 型全局變量,函數(shù) Squre_Exam 返回 Exam 平方值。那么如下函數(shù)不具有可重入性。unsigned int example( int para )unsigned int temp;para; / (*)Square_Exam( );Exa

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

最新文檔

評論

0/150

提交評論