第5章 華為軟件編碼規(guī)范

29二月20241課程名稱：軟件工程任課教師：郭雷勇E-mail:guoly2004@第5章軟件編碼——華為軟件編程規(guī)范和范例29二月20242華為軟件編程規(guī)范和范例--------------------------------------------〔一〕=====[排版]]=======.〔二〕======[注釋]=======.〔三〕=====[標(biāo)識符命名]=======.〔四〕=====[可讀性]======.〔五〕=====[變量、結(jié)構(gòu)]=====.〔六〕=====[函數(shù)、過程]=====.〔七〕=====[可測性]=====.〔八〕=====[程序效率]=====.〔九〕=====[質(zhì)量保證]=====.〔十〕=====[代碼編輯、編譯、審查]=====.〔十一〕=====[代碼測試、維護]=====.〔十二〕=====[宏]=====.29二月20243〔一〕=====[排版]29二月2024411-1：程序塊要采用縮進風(fēng)格編寫，縮進的空格數(shù)為4個

說明：對于由開發(fā)工具自動生成的代碼可以有不一致。29二月2024511-2：相對獨立的程序塊之間、變量說明之后必須加空行示例：如下例子不符合規(guī)范。if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;應(yīng)如下書寫if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;29二月2024611-3：較長的語句（>80字符）要分成多行書寫，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當(dāng)?shù)目s進，使排版整齊，語句可讀

示例：perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(_UL);act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied=stat_poi[index].occupied;act_task_table[taskno].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_table[taskno].result_data!=0));29二月2024711-4：循環(huán)、判斷等語句中若有較長的表達式或語句，則要進行適應(yīng)的劃分，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首

if((taskno<max_act_task_number)&&(n7stat_stat_item_valid(stat_item))){...//programcode}for(i=0,j=0;(i<BufferKeyword[word_index].word_length)&&(j<NewKeyword.word_length);i++,j++){...//programcode}for(i=0,j=0;(i<first_word_length)&&(j<second_word_length);i++,j++){...//programcode}29二月2024811-5：若函數(shù)或過程中的參數(shù)較長，則要進行適當(dāng)?shù)膭澐质纠簄7stat_str_compare((BYTE*)&stat_object,(BYTE*)&(act_task_table[taskno].stat_object),sizeof(_STAT_OBJECT));n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER+index,stat_object);29二月2024911-6：不允許把多個短語句寫在一行中，即一行只寫一條語句示例：如下例子不符合規(guī)范。rect.length=0;rect.width=0;應(yīng)如下書寫rect.length=0;rect.width=0;29二月20241011-7：if、for、do、while、case、switch、default等語句自占一行，且if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號{}示例：如下例子不符合規(guī)范。if(pUserCR==NULL)return;應(yīng)如下書寫：if(pUserCR==NULL){return;}29二月20241111-8：對齊只使用空格鍵，不使用TAB鍵說明：以免用不同的編輯器閱讀程序時，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因為BC會自動將8個空格變?yōu)橐粋€TAB鍵，因此使用BC合入的版本大多會將縮進變亂。29二月20241211-9：函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風(fēng)格，case語句下的情況處理語句也要遵從語句縮進要求11-10：程序塊的分界符（如C/C++語言的大括號‘{’和‘}’）應(yīng)各獨占一行并且位于同一列，同時與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進方式29二月202413示例：如下例子不符合規(guī)范。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}應(yīng)如下書寫。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}29二月20241411-11：在兩個以上的關(guān)鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之后或者前后要加空格；進行非對等操作時，如果是關(guān)系密切的立即操作符（如－>），后不應(yīng)加空格。(1)逗號、分號只在后面加空格。inta,b,c;(2)比較操作符,賦值操作符"="、"+="，算術(shù)操作符"+"、"%"，邏輯操作符"&&"、"&"，位域操作符"<<"、"^"等雙目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;29二月202415(3)"!"、"~"、"++"、"--"、"&"（地址運算符）等單目操作符前后不加空格。*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等與后面的括號間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。if(a>=b&&c>d)注意：一行程序以小于80字符為宜，不要寫得過長。

29二月202416〔二〕======[注釋]=======29二月20241712-1：一般情況下，源程序有效注釋量必須在20％以上

說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準確、易懂、簡潔。29二月20241812-2：說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應(yīng)進行注釋，注釋必須列出：版權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明示例：下面這段頭文件的頭注釋比較標(biāo)準，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/*************************************************Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.Filename://文件名

Author:Version:Date://作者、版本及完成日期

Description://用于詳細說明此程序文件完成的主要功能，與其他模塊

//或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控

//制、順序、獨立或依賴等關(guān)系

Others://其它內(nèi)容的說明

FunctionList://主要函數(shù)列表，每條記錄應(yīng)包括函數(shù)名及功能簡要說明

1.....History://修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改

//者及修改內(nèi)容簡述

1.Date:Author:Modification:2....*************************************************/29二月20241912-3：源文件頭部應(yīng)進行注釋，列出：版權(quán)說明、版本號、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例：下面這段源文件的頭注釋比較標(biāo)準，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/************************************************************Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.FileName:test.cppAuthor:Version:Date:Description://模塊描述

Version://版本信息

FunctionList://主要函數(shù)及其功能

1.-------History://歷史修改記錄

<author><time><version><desc>David96/10/121.0buildthismoudle***********************************************************/說明：Description一項描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡述。29二月20242012-4：函數(shù)頭部應(yīng)進行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等示例：下面這段函數(shù)的注釋比較標(biāo)準，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/*************************************************Function://函數(shù)名稱

Description://函數(shù)功能、性能等的描述

Calls://被本函數(shù)調(diào)用的函數(shù)清單

CalledBy://調(diào)用本函數(shù)的函數(shù)清單

TableAccessed://被訪問的表（此項僅對于牽扯到數(shù)據(jù)庫操作的程序）

TableUpdated://被修改的表（此項僅對于牽扯到數(shù)據(jù)庫操作的程序）

Input://輸入?yún)?shù)說明，包括每個參數(shù)的作

//用、取值說明及參數(shù)間關(guān)系。

Output://對輸出參數(shù)的說明。

Return://函數(shù)返回值的說明

Others://其它說明*************************************************/29二月20242112-5：邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除

說明：錯誤的注釋不但無益反而有害。12-6：注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性規(guī)則2-7：避免在注釋中使用縮寫，特別是非常用縮寫

說明：在使用縮寫時或之前，應(yīng)對縮寫進行必要的說明。29二月20242212-8：注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開示例：如下例子不符合規(guī)范。例1：repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;/*getreplicatesubsystemindexandnetindicator*/應(yīng)如下書寫/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;29二月20242312-9：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方

示例：/*activestatistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/29二月20242412-10：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋放在此域的右方示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。/*sccpinterfacewithsccpuserprimitivemessagename*/enumSCCP_USER_PRIMITIVE{N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*//*transmissionthismessage*/N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/};29二月20242512-11：全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明示例：/*TheErrorCodewhenSCCPtranslate*//*GlobalTitlefailure,asfollows*///變量作用、含義/*0－SUCCESS1－GTTableerror*//*2－GTerrorOthers－nouse*///變量取值范圍/*onlyfunctionSCCPTranslate()in*//*thismodualcanmodifyit,andother*//*modulecanvisititthroughcall*//*thefunctionGetGTTransErrorCode()*///使用方法BYTEg_GTTranErrorCode;29二月20242612-12：注釋與所描述內(nèi)容進行同樣的縮排說明：可使程序排版整齊，并方便注釋的閱讀與理解。示例：如下例子，排版不整齊，閱讀稍感不方便。voidexample_fun(void){/*codeonecomments*/CodeBlockOne

/*codetwocomments*/CodeBlockTwo}應(yīng)改為如下布局。voidexample_fun(void){/*codeonecomments*/CodeBlockOne/*codetwocomments*/CodeBlockTwo}29二月20242712-13：將注釋與其上面的代碼用空行隔開示例：如下例子，顯得代碼過于緊湊。/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo應(yīng)如下書寫/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo29二月20242812-14：對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋

說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護人員來說，良好的注釋幫助更好的理解程序，有時甚至優(yōu)于看設(shè)計文檔。29二月20242912-15：對于switch語句下的case語句，如果因為特殊情況需要處理完一個case后進入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。示例（注意斜體加粗部分）：caseCMD_UP:ProcessUp();break;caseCMD_DOWN:ProcessDown();break;caseCMD_FWD:ProcessFwd();if(...){...break;}else{ProcessCFW_B();//nowjumpintocaseCMD_A}caseCMD_A:ProcessA();break;caseCMD_B:ProcessB();break;caseCMD_C:ProcessC();break;caseCMD_D:ProcessD();break;...29二月202430說明?2-1：避免在一行代碼或表達式的中間插入注釋說明：除非必要，不應(yīng)在代碼或表達中間插入注釋，否則容易使代碼可理解性變差。?2-2：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的說明：清晰準確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。29二月202431?2-3：在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。示例：如下注釋意義不大。/*ifreceive_flagisTRUE*/if(receive_flag)而如下的注釋則給出了額外有用的信息。/*ifmtpreceiveamessagefromlinks*/if(receive_flag)29二月202432?2-4：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束說明：當(dāng)代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。示例：參見如下例子。if(...){//programcodewhile(index<MAX_INDEX){//programcode}/*endofwhile(index<MAX_INDEX)*///指明該條while語句結(jié)束}/*endofif(...)*///指明是哪條if語句結(jié)束29二月202433?2-5：注釋格式盡量統(tǒng)一，建議使用“/*……*/”?2-6：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準確的英文表達說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護人員的考慮，建議使用中文。29二月202434〔三〕===[標(biāo)識符命名]=======29二月20243513-1：標(biāo)識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。示例：如下單詞的縮寫能夠被大家基本認可。temp可縮寫為tmp;flag可縮寫為flg;statistic可縮寫為stat;increment可縮寫為inc;message可縮寫為msg;29二月20243613-2：命名中若使用特殊約定或縮寫，則要有注釋說明說明：應(yīng)該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。29二月20243713-3：自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化

說明：個人的命名風(fēng)格，在符合所在項目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個人命名風(fēng)格）。29二月20243813-4：對于變量命名，禁止取單個字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的

說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。示例：下面所示的局部變量名的定義方法可以借鑒。intliv_Width其變量名解釋如下：

l局部變量（Local）（其它：g全局變量（Global）...）

i數(shù)據(jù)類型（Interger）

v變量（Variable）（其它：c常量（Const）...）

Width變量含義這樣可以防止局部變量與全局變量重名。29二月20243913-5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項目中統(tǒng)一，比如