華為軟件編程規范_第1頁
華為軟件編程規范_第2頁
華為軟件編程規范_第3頁
華為軟件編程規范_第4頁
華為軟件編程規范_第5頁
已閱讀5頁,還剩50頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

1、編譯、審查 維護611182022283640445052531 排版2 注釋3 標識符命名4 可讀性5 變量、結構6 函數、過程7 可測性8 程序效率9 質量保證10 代碼編輯、編譯、審查11 代碼測試、維護12 宏軟件編程規范總則1排版1排版11-1 :程序塊要采用縮進風格編寫,縮進的空格數為4個。說明:對于由開發工具自動生成的代碼可以有不一致。11-2 :相對獨立的程序塊之間、變量說明之后必須加空行。示例:如下例子不符合規范。if (!valid_ni(ni) program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni =

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

3、t_task_tableframe_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_tableta

4、skno.result_data != 0);僅供內部使用711-4 :循環、判斷等語句中若有較長的表達式或語句,則要進行適應的劃分,長表達式要在低優先級操作符處劃 分新行,操作符放在新行之首。示例: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)

5、; i+, j+) program codefor (i = 0, j = 0;(i < first_word_length) && (j < second_word_length);i+, j+) program code11-5 :若函數或過程中的參數較長,則要進行適當的劃分。示例:n7stat_str_compare(BYTE *) & stat_object,(BYTE *) & (act_task_tabletaskno.stat_object),sizeof (_STAT_OBJECT);n7stat_flash_act_duration

6、( stat_item, frame_id *STAT_TASK_CHECK_NUMBER+ index, stat_object );11-6 :不允許把多個短語句寫在一行中,即一行只寫一條語句。示例:如下例子不符合規范。rect.length = 0; rect.width = 0;應如下書寫rect.length = 0;rect.width = 0;11-7 : if、for、do、while 、case、switch 、default等語句自占一行,且 if、for、do、while 等語句的執行語句部分無論多少都要加括號 0示例:如下例子不符合規范。if (pUserCR = NU

7、LL) return;應如下書寫:if (pUserCR = NULL) return;11-8 :對齊只使用空格鍵,不使用 TAB鍵。說明:以免用不同的編輯器閱讀程序時,因TAB鍵所設置的空格數目不同而造成程序布局不整齊,不要使用BC作為編輯器合版本,因為 BC會自動將8個空格變為一個 TAB鍵,因此使用BC合入的版本大多會將 縮進變亂。11-9 :函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要采用縮進風格,case語句下的情況處理語句也要遵從語句縮進要求。11-10 :程序塊的分界符(如 C/C+語言的大括號和'')應各獨占一行并且位于同一列,同時與引用它 們的

8、語句左對齊。在函數體的開始、類的定義、結構的定義、枚舉的定義以及if、for、do、while 、switchcase語句中的程序都要采用如上的縮進方式。示例:如下例子不符合規范。for (.) program codeif (.)./ program codevoid example_fun( void ) program code應如下書寫。for (.) program codeif (.)./ program codevoid example_fun( void )./ program code 11-11 :在兩個以上的關鍵字、變量、常量進行對等操作時,它們之間的操作符之前、之后或者

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

10、ot;+=",算術操作符"+"、"",邏輯操作符"&&"、"&",位域操作符"<<"、"A"等雙目操作符的前后加空格。if (current_time >= MAX_TIME_VALUE) a = b + c;a *= 2;a = b A 2;(3)"!"、""、"+"、"-" 、"&,(地址運算符)等單目操作符前后不加空格。*

11、p = 'a'/內容操作"*"與內容之間flag = !isEmpty; 非操作"!”與內容之間p = &mem; /地址操作"&"與內容之間i+;/ "+","-"與內容之間(4)"->"、"."前后不加空格。p->id = pid; "->"指針前后不加空格(5) if 、for、while 、switch等與后面的括號間應加空格,使 if等關鍵字更為突出、明顯。if (a >= b &

12、amp;& c > d)?1-1 : 一行程序以小于80字符為宜,不要寫得過長。軟件編程規范總則2注釋僅供內部使用132注釋12-1 :一般情況下,源程序有效注釋量必須在20 %以上。說明:注釋的原則是有助于對程序的閱讀理解,在該加的地方都加了,注釋不宜太多也不 能太少,注釋語言必須準確、易懂、簡潔。頭部應12-2 :說明性文件(如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等) 進行注釋,注釋必須列出:版權說明、版本號、生成日期、作者、內容、功能、與其它文件的 關系、修改日志等,頭文件的注釋中還應有函數功能簡要說明。/*示例:下面這段頭文件的頭注釋比較標準,

13、當然,并不局限于此格式,但上述信息建議要 包含在內。*Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.File name: /文件名Author:Version:Date: /作者、版本及完成日期Description: /用于詳細說明此程序文件完成的主要功能,與其他模塊/或函數的接口,輸出值、取值范圍、含義及參數間的控/制、順序、獨立或依賴等關系Others:/其它內容的說明Function List: /1.主要函數列表,每條記錄應包括函數名及功能簡要說明History:/修改歷史記錄列表,每條修改記錄應包括修改日期、修改/者及修改內容簡述1

14、. Date:Author:Modification:2.*/*/功能、12-3 :源文件頭部應進行注釋,列出:版權說明、版本號、生成日期、作者、模塊目的 主要函數及其功能、修改日志等。示例:下面這段源文件的頭注釋比較標準,當然,并不局限于此格式,但上述信息建議要 包含在內。/*Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.FileName: test.cppAuthor:Version :Description: /Version:/Function List: /1.History:/<author> <time>D

15、avid 96/10/12Date:模塊描述版本信息主要函數及其功能歷史修改記錄version > <desc>1.0 build this moudle*/說明:Description一項描述本文件的內容、功能、內部各部分之間的關系及本文件與其它文件關系等。History是修改歷史記錄列表,每條修改記錄應包括修改日期、修改者及修改內容簡述。12-4 :函數頭部應進行注釋,列出:函數的目的/功能、輸入參數、輸出參數、返回值、調用關系(函數、表)等。示例:下面這段函數的注釋比較標準,當然,并不局限于此格式,但上述信息建議要包含在內。/*Function:/函數名稱Descrip

16、tion:/函數功能、性能等的描述Calls:/被本函數調用的函數清單Called By:/調用本函數的函數清單Table Accessed: /被訪問的表(此項僅對于牽扯到數據庫操作的程序)Table Updated: /被修改的表(此項僅對于牽扯到數據庫操作的程序)Input:/輸入參數說明,包括每個參數的作/用、取值說明及參數間關系。Output:/對輸出參數的說明。Return:/函數返回值的說明Others:/其它說明*/12-5 :邊寫代碼邊注釋,修改代碼同時修改相應的注釋,以保證注釋與代碼的一致性。不再有 用的注釋要刪除。12-6 :注釋的內容要清楚、明了,含義準確,防止注釋二義

17、性。說明:錯誤的注釋不但無益反而有害。規則2-7 :避免在注釋中使用縮寫,特別是非常用縮寫。說明:在使用縮寫時或之前,應對縮寫進行必要的說明。12-8 :注釋應與其描述的代碼相近,對代碼的注釋應放在其上方或右方(對單條語句的注釋) 相鄰位置,不可放在下面,如放于上方則需與其上面的代碼用空行隔開。示例:如下例子不符合規范。例1 :/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;例2 :repssn_i

18、nd = 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;12-9 :對于所有有物理含義的變量、常量,如果其命名不是充分自注釋的,在聲明時都必須加 以注釋,說明其物理含義。

19、變量、常量、宏的注釋應放在其上方相鄰位置或右方。示例:/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000*/#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number 12-10 :數據結構聲明(包括數組、結構、類、枚舉等 ),如果其命名不是充分自注釋的,必須 加以注釋。對數據結構的注釋應放在其上方相鄰位置,不可放在下面;對結構中的每個域的注 釋放在此域的右方。示例:可按如下形式說明枚舉/數據/聯合結構。/* sccp interface wi

20、th 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*/ ;12-11 :全局變量要有較詳細的注釋,

21、包括對其功能、取值范圍、哪些函數或過程存取它以及 存取時注意事項等的說明。示例:/* 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 throug

22、h call */* the function GetGTTransErrorCode() */ /BYTE g_GTTranErrorCode;12-12 :注釋與所描述內容進行同樣的縮排。說明:可使程序排版整齊,并方便注釋的閱讀與理解。示例:如下例子,排版不整齊,閱讀稍感不方便。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two應改為如下布局。void example_fun( void )/* code one comments */CodeBlo

23、ck One/* code two comments */CodeBlock Two12-13 :將注釋與其上面的代碼用空行隔開。示例:如下例子,顯得代碼過于緊湊。/* code one comments */program code one/* code two comments */program code two應如下書寫/* code one comments */program code one/* code two comments */program code two12-14 :對變量的定義和分支語句(條件分支、循環語句等)必須編寫注釋。說明:這些語句往往是程序實現某一特定功能

24、的關鍵,對于維護人員來說,良好的注釋幫助更好的理解程序,有時甚至優于看設計文檔。12-15 :對于switch 語句下的case語句,如果因為特殊情況需要處理完一個case后進入下個case處理,必須在該case語句處理完、下一個 case語句前加上明確的注釋。說明:這樣比較清楚程序編寫者的意圖,有效防止無故遺漏break語句。示例(注意斜體加粗部分):case CMD_UP:ProcessUp();break;case CMD_DOWN:ProcessDown();break;case CMD_FWD:ProcessFwd();if (.) . break; elseProcessCFW_B

25、(); / now jump into case CMD_A case CMD_A:ProcessA();break;case CMD_B:ProcessB();break;case CMD_C:ProcessC();break;case CMD_D:ProcessD();break;.? 2-1 :避免在一行代碼或表達式的中間插入注釋。說明:除非必要,不應在代碼或表達中間插入注釋,否則容易使代碼可理解性變差。? 2-2:通過對函數或過程、變量、結構等正確的命名以及合理地組織代碼的結構,使代碼成為 自注釋的。說明:清晰準確的函數、變量等的命名,可增加代碼可讀性,并減少不必要的注釋。?2-3:在

26、代碼的功能、意圖層次上進行注釋,提供有用、額外的信息。說明:注釋的目的是解釋代碼的目的、功能和采用的方法,提供代碼以外的信息,幫助讀者理解代碼,防止沒必要的重復注釋信息。示例:如下注釋意義不大。/* if receive_flag is TRUE */ if (receive_flag)而如下的注釋則給出了額外有用的信息。/* if mtp receive a message from links */ if (receive_flag)? 2-4:在程序塊的結束行右方加注釋標記,以表明某程序塊的結束。說明:當代碼段較長,特別是多重嵌套時,這樣做可以使代碼更清晰,更便于閱讀。示例:參見如下例子

27、。if (.)/ program codewhile (index < MAX_INDEX)/ program code/* end of while (index < MAX_INDEX) */指明該條 while 語句結束 /* end of if (.)*/ /指明是哪條if 語句結束? 2-5:注釋格式盡量統一,建議使用" /*/ "。?2-6:注釋應考慮程序易讀及外觀排版的因素,使用的語言若是中、英兼有的,建議多使用中 文,除非能用非常流利準確的英文表達。說明:注釋語言不統一,影響程序易讀性和外觀排版,出于對維護人員的考慮,建議使用中文。軟件編程規范總

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

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

30、全局變量(Global ).)常量(Const ).)l 局部變量(Local ) (其它:gi數據類型(Interger)v變量(Variable ) (其它:cWidth 變量含義這樣可以防止局部變量與全局變量重名。13-5 :命名規范必須與所使用的系統風格保持一致,并在同一項目中統一,比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式,不要使用大小寫與下劃線混排的方式,用作特殊 標識如標識成員變量或全局變量的m_g_ ,其后加上大小寫混排的方式是允許的。示例:Add_User 不允許,add_user 、AddUser、m_AddUser 允許。? 3-1 :除非必要,不要用數字或

31、較奇怪的字符來定義標識符。 示例:如下命名,使人產生疑惑。#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-2:在同一軟件產品內,應規劃好接口部分標識符(變量、結構、函數及常量)的命名,防 止編譯、鏈接時產生沖突。說明:對接口部分的標識符應該有更嚴格限制,防止沖突。如可規定接口部分的變量與

32、常 量之前加上“模塊”標識等。?3-3 :用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等。 說明:下面是一些在軟件中常用的反義詞組。add / remove begin / end create / destroy insert / delete first / last get / release increment / decrementput / getadd / delete lock / unlock open / close min / max old / new start / stop next / previous source / target show / hi

33、de send / receive source / destination cut / paste up / down 示例:int min_sum;int max_sum;int add_user( BYTE *user_name );int delete_user( BYTE *user_name );? 3-4:除了編譯開關/頭文件等特殊應用,應避免使用_EXAMPLE_TEST_之類以下戈IJ線開始和 結尾的定義。僅供內部使用15軟件編程規范總則4可讀性4可讀性14-1 :注意運算符的優先級,并用括號明確表達式的操作順序,避免使用默認優先級。 說明:防止閱讀程序時產生誤解,防止因默認

34、的優先級與設計思想不符而導致程序出錯。 示例:下列語句中的表達式word = (high << 8) | low if (a | b) && (a & c)(2)if (a I b) < (c & d)(3)如果書寫為high << 8 | low a | b && a & c a | b < c & d由于high << 8 | low = ( high << 8) | low,a | b && a & c = (a | b) &&

35、; (a & c),(2)不會出錯,但語句不易理解;a | b < c & d = a |(b < c ) & d , (3)造成了判斷條件出錯。14-2 :避免使用不易理解的數字,用有意義的標識來替代。涉及物理狀態或者含有物理意義的 常量,不應直接使用數字,必須用有意義的枚舉或宏來代替。示例:如下的程序可讀性差。if (Trunkindex.trunk_state = 0)Trunkindex.trunk_state = 1;./ program code 應改為如下形式。#define TRUNK_IDLE 0#define TRUNK_BUSY 1if

36、 (Trunkindex.trunk_state = TRUNK_IDLE)Trunkindex.trunk_state = TRUNK_BUSY;./ program code?4-1 :源程序中關系較為緊密的代碼應盡可能相鄰。說明:便于程序閱讀和查找。示例:以下代碼布局不太合理。rect.length = 10;char_poi = str;rect.width = 5;若按如下形式書寫,可能更清晰一些。rect.length = 10;rect.width = 5; /矩形的長與寬關系較密切,放在一起。僅供內部使用17char_poi = str;? 4-2:不要使用難懂的技巧性很高的語

37、句,除非很有必要時。說明:高技巧語句不等于高效率的程序,實際上程序的效率關鍵在于算法。示例:如下表達式,考慮不周就可能出問題,也較難理解。* stat_poi + += 1;* + stat_poi += 1;應分別改為如下。stat_poi+; /*stat_poi += 1;此二語句功能相當于"* stat_poi + += 1;*stat_poi += 1; /+ stat_poi;此二語句功能相當于"* + stat_poi += 1;軟件編程規范總則5變量、結構5變量、結構15-1 :去掉沒必要的公共變量。說明:公共變量是增大模塊間耦合的原因之一,故應減少沒必要的

38、公共變量以降低模塊間 的耦合度。15-2 :仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系。說明:在對變量聲明的同時,應對其含義、作用及取值范圍進行注釋說明,同時若有必要 還應說明與其它變量的關系。15-3 :明確公共變量與操作此公共變量的函數或過程的關系,如訪問、修改及創建等。說明:明確過程操作變量的關系后,將有利于程序的進一步優化、單元測試、系統聯調以 及代碼維護等。這種關系的說明可在注釋或文檔中描述。示例:在源文件中,可按如下注釋形式說明。RELATION System_Init Input_Rec Print_Rec Stat_ScoreStudent Create M

39、odify Access AccessScore Create Modify Access Access, Modify注:RELATION 為操作關系;System_Init 、Input_Rec 、Print_Rec 、Stat_Score 為四個不同的函數;Student 、Score 為兩個全局變量;Create 表示創建,Modify 表 示修改,Access 表示訪問。其中,函數Input_Rec 、Stat_Score 都可修改變量 Score ,故此變量將引起函數間較 大的耦合,并可能增加代碼測試、維護的難度。15-4 :當向公共變量傳遞數據時,要十分小心,防止賦與不合理的值或

40、越界等現象發生。 說明:對公共變量賦值時,若有必要應進行合法性檢查,以提高代碼的可靠性、穩定性。15-5 :防止局部變量與公共變量同名。說明:若使用了較好的命名規則,那么此問題可自動消除。15-6 :嚴禁使用未經初始化的變量作為右值。說明:特別是在 C/C+中引用未經賦值的指針,經常會引起系統崩潰。? 5-1 :構造僅有一個模塊或函數可以修改、創建,而其余有關模塊或函數只訪問的公共變量, 防止多個不同模塊或函數都可以修改、創建同一公共變量的現象。說明:降低公共變量耦合度。? 5-2:使用嚴格形式定義的、可移植的數據類型,盡量不要使用與具體硬件或軟件環境關系密 切的變量。說明:使用標準的數據類型

41、,有利于程序的移植。示例:如下例子(在 DOS下BC3.1環境中),在移植時可能產生問題。void main()register int index; /寄存器變量_AX = 0x4000;/_AX是BC3.1提供的寄存器“偽變量” program code? 5-3:結構的功能要單一,是針對一種事務的抽象。說明:設計結構時應力爭使結構代表一種現實事務的抽象,而不是同時代表多種。結構中 的各元素應代表同一事務的不同側面,而不應把描述沒有關系或關系很弱的不同事務的元素放到同一結構中。示例:如下結構不太清晰、合理。typedef struct STUDENT_STRUunsigned char n

42、ame8; /* 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 student teacher's name */unisgned charteacher_sex; /* his teacher sex */ STUDENT;若改為如下,可能更合理些。typedef struct T

43、EACHER_STRUunsigned char name8; /* teacher name */ unisgned char sex; /* teacher sex, as follows */* 0 - FEMALE; 1 - MALE */ TEACHER;typedef struct STUDENT_STRUunsigned char name8; /* student's name */ unsigned char age;/* student's age */unsigned char sex;/* student's sex, as follows */

44、* 0 - FEMALE; 1 - MALE */ unsigned int teacher_ind; /* his teacher index */ STUDENT;?5-4:不要設計面面俱到、非常靈活的數據結構。說明:面面俱到、靈活的數據結構反而容易引起誤解和操作困難。?5-5:不同結構間的關系不要過于復雜。說明:若兩個結構間關系較復雜、密切,那么應合為一個結構。 示例:如下兩個結構的構造不合理。typedef struct PERSON_ONE_STRUunsigned char name8;unsigned char addr40;unsigned char sex;unsigned

45、char city15; PERSON_ONE;typedef struct PERSON_TWO_STRUunsigned char name8;unsigned char age;unsigned char tel; PERSON_TWO;由于兩個結構都是描述同一事物的,那么不如合成一個結構。typedef struct PERSON_STRU unsigned char name8;unsigned char age;unsigned char sex;unsigned char addr40;unsigned char city15;unsigned char tel; PERSON;

46、?5-6:結構中元素的個數應適中。若結構中元素個數過多可考慮依據某種原則把元素組成不同 的子結構,以減少原結構中元素的個數。說明:增加結構的可理解性、可操作性和可維護性。示例:假如認為如上的_PERSON結構元素過多,那么可如下對之劃分。typedef struct PERSON_BASE_INFO_STRU unsigned char name8;unsigned char age;unsigned char sex; PERSON_BASE_INFO;typedef struct PERSON_ADDRESS_STRUunsigned char addr40;unsigned char c

47、ity15;unsigned char tel;PERSON_ADDRESS;typedef struct PERSON_STRUPERSON_BASE_INFO person_base;PERSON_ADDRESS person_addr; PERSON;?5-7:仔細設計結構中元素的布局與排列順序,使結構容易理解、節省占用空間,并減少引起 誤用現象。說明:合理排列結構中元素順序,可節省空間并增加可理解性。示例:如下結構中的位域排列,將占較大空間,可讀性也稍差。typedef struct EXAMPLE_STRUunsigned int valid: 1;PERSON person;uns

48、igned int set_flg: 1; EXAMPLE;若改成如下形式,不僅可節省1字節空間,可讀性也變好了。typedef struct EXAMPLE_STRUunsigned int valid: 1;unsigned int set_flg: 1;PERSON person ; EXAMPLE;? 5-8:結構的設計要盡量考慮向前兼容和以后的版本升級,并為某些未來可能的應用保留余地 (如預留一些空間等)。說明:軟件向前兼容的特性,是軟件產品是否成功的重要標志之一。如果要想使產品具有 較好的前向兼容,那么在產品設計之初就應為以后版本升級保留一定余地,并且在產品升 級時必須考慮前一版本

49、的各種特性。? 5-9 :留心具體語言及編譯器處理不同數據類型的原則及有關細節。說明:如在C語言中,static 局部變量將在內存“數據區”中生成,而非 static 局部 變量將在“堆棧”中生成。這些細節對程序質量的保證非常重要。? 5-10:編程時,要注意數據類型的強制轉換。說明:當進行數據類型強制轉換時,其數據的意義、轉換后的取值等都有可能發生變化,而這些細節若考慮不周,就很有可能留下隱患。?5-11 :對編譯系統默認的數據類型轉換,也要有充分的認識。示例:如下賦值,多數編譯器不產生告警,但值的含義還是稍有變化。char chr;unsigned short int exam;chr =

50、 -1;exam = chr; 編譯器不產生告警,此時 exam為0xFFFF 。? 5-12 :盡量減少沒有必要的數據類型默認轉換與強制轉換。? 5-13:合理地設計數據并使用自定義數據類型,避免數據間進行不必要的類型轉換。?5-14:對自定義數據類型進行恰當命名,使它成為自描述性的,以提高代碼可讀性。注意其 命名方式在同一產品中的統一。說明:使用自定義類型,可以彌補編程語言提供類型少、信息量不足的缺點,并能使程序清晰、簡潔。示例:可參考如下方式聲明自定義數據類型。下面的聲明可使數據類型的使用簡潔、明了。typedef unsigned char BYTE;typedef unsigned

51、short WORD;typedef unsigned int DWORD;下面的聲明可使數據類型具有更豐富的含義。typedef float DISTANCE;typedef float SCORE;? 5-15:當聲明用于分布式環境或不同CPU間通信環境的數據結構時,必須考慮機器的字節順 序、使用的位域及字節對齊等問題。說明:比如Intel CPU 與68360 CPU ,在處理位域及整數時,其在內存存放的“順序” 正好相反。示例:假如有如下短整數及結構。unsigned short int exam;typedef struct EXAM_BIT_STRU/* Intel 68360 *

52、/unsigned int A1: 1; /* bit 07 */unsigned int A2: 1;/* bit 16 */unsigned int A3: 1;/* bit 25 */ EXAM_BIT;如下是Intel CPU生成短整數及位域的方式。內存:012 .(從低到高,以字節為單位)exam exam 低字節 exam 高字節內存: 0 bit 1 bit 2 bit .(字節的各“位”)EXAM_BIT A1 A2 A3如下是68360 CPU生成短整數及位域的方式。內存:012 .(從低到高,以字節為單位)exam exam 高字節 exam 低字節內存: 7 bit 6

53、bit 5 bit .(字節的各“位”)EXAM_BIT A1 A2 A3說明:在對齊方式下,CPU的運行效率要快得多。示例:如下圖,當一個long型數(如圖中long1 )在內存中的位置正好與內存的字邊界 對齊時,CPU存取這個數只需訪問一次內存,而當一個long型數(如圖中的long2 )在內存中的位置跨越了字邊界時,CPU存取這個數就需要多次訪問內存,如i960cx 訪問這樣的數需讀內存三次(一個 BYTE、一個SHORT、一個BYTE,由CPU的微代碼執行,對 軟件透明),所有對齊方式下 CPU的運行效率明顯快多了。18162432 110ng1 | 10ngi 110ng1 110n

54、g1 | I I I I long2 | 110ng2 | long2 110ng2 | I .僅供內部使用23軟件編程規范總則6函數、過程6函數、過程16-1 :對所調用函數的錯誤返回碼要仔細、全面地處理。16-2 :明確函數功能,精確(而不是近似)地實現函數設計。16-3 :編寫可重入函數時,應注意局部變量的使用(如編寫C/C+語言的可重入函數時,應使用auto即缺省態局部變量或寄存器變量)。說明:編寫C/C+語言的可重入函數時,不應使用static局部變量,否則必須經過特殊處理,才能使函數具有可重入性。16-4 :編寫可重入函數時,若使用全局變量,則應通過關中斷、信號量(即P、V操作)等手段對其加以保護。說明:若對所使用的全局變量不加以保護,則此函數就不具有可重入性,即當多個進程調 用此函數時,很有可能使有關全局變量變為不可知狀態。示例:假設Exam是int 型全局變量,函數 Squre_Exam 返回Exam平方值。那么如下 函數不具有可重入性。u

溫馨提示

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

最新文檔

評論

0/150

提交評論