CC語言編程規(guī)范

目錄1排版 24可讀性 116函數(shù)、過程 137可測性 141排版1-1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個。說明：對于由開發(fā)工具自動生成的代碼可以有不一致。1-2：相對獨(dú)立的程序塊之間、變量說明之后必須加空行。示例：如下例子不符合規(guī)范。if(!valid_ni(ni)){...epssn_index;repssn_ni=ssn_data[index].ni;應(yīng)如下書寫if(!valid_ni(ni)){...epssn_index;repssn_ni=ssn_data[index].ni;1-3：較長的語句（>80字符）要分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。示例：=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));1-4：循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。示例：if((taskno<max_act_task_number)&&(n7stat_stat_item_valid(stat_item))){...ord_length)&&(j<;i++,j++){....tat_object),sizeof(_STAT_OBJECT));n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER+index,stat_object);1-6：不允許把多個短語句寫在一行中，即一行只寫一條語句。示例：如下例子不符合規(guī)范。=0;=0;應(yīng)如下書寫=0;=0;1-7：if、for、do、while、case、switch、default等語句自占一行，且if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號{}。示例：如下例子不符合規(guī)范。if(pUserCR==NULL)return;應(yīng)如下書寫：if(pUserCR==NULL){return;}1-8：對齊只使用空格鍵，不使用TAB鍵。說明：以免用不同的編輯器閱讀程序時，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因?yàn)锽C會自動將8個空格變?yōu)橐粋€TAB鍵，因此使用BC合入的版本大多會將縮進(jìn)變亂。1-9：函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格，case語句下的情況處理語句也要遵從語句縮進(jìn)要求。1-10：程序塊的分界符（如C/C++語言的大括號‘{’和‘}’）應(yīng)各獨(dú)占一行并且位于同一列，同時與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進(jìn)方式。示例：如下例子不符合規(guī)范。for(...){....){.....){....){....前后不加空格。p->id=pid;文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明。示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/*************************************************Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.Filename:History:Date:Author:Modification:2....*************************************************/2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說明、版本號、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/************************************************************Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.FileName:Author:Version:Date:Description:History:epssn_index;repssn_ni=ssn_data[index].ni;例2：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;2-9：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。示例：/*activestatistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/2-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,/*sccpnotifyuserthenetworkcannot*//*transmissionthismessage*/N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/};2-11：全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項(xiàng)等的說明。示例：/*TheErrorCodewhenSCCPtranslate*//*GlobalTitlefailure,asfollows*/.){...break;}else{ProcessCFW_B();.2-1：避免在一行代碼或表達(dá)式的中間插入注釋。說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。2-2：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。2-3：在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。示例：如下注釋意義不大。/*ifreceive_flagisTRUE*/if(receive_flag)而如下的注釋則給出了額外有用的信息。/*ifmtpreceiveamessagefromlinks*/if(receive_flag)2-4：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。說明：當(dāng)代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。示例：參見如下例子。if(...){.)*/.），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費(fèi)大量的查錯時間。示例：下面所示的局部變量名的定義方法可以借鑒。intliv_Width其變量名解釋如下： l局部變量（Local）（其它：g全局變量（Global）...） i數(shù)據(jù)類型（Interger） v變量（Variable）（其它：c常量（Const）...） Width變量含義這樣可以防止局部變量與全局變量重名。3-5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標(biāo)識如標(biāo)識成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的。示例：Add_User不允許，add_user、AddUser、m_AddUser允許。3-1：除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識符。示例：如下命名，使人產(chǎn)生疑惑。#define_EXAMPLE_0_TEST_#define_EXAMPLE_1_TEST_voidset_sls00(BYTEsls);應(yīng)改為有意義的單詞命名#define_EXAMPLE_UNIT_TEST_#define_EXAMPLE_ASSERT_TEST_voidset_udt_msg_sls(BYTEsls);3-2：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時產(chǎn)生沖突。說明：對接口部分的標(biāo)識符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識等。3-3：用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。說明：下面是一些在軟件中常用的反義詞組。add/removebegin/endcreate/destroyinsert/deletefirst/lastget/releaseincrement/decrementput/getadd/deletelock/unlockopen/closemin/maxold/newstart/stopnext/previoussource/targetshow/hidesend/receivesource/destinationcut/pasteup/down示例：intmin_sum;intmax_sum;intadd_user(BYTE*user_name);intdelete_user(BYTE*user_name);3-4：除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義。4可讀性4-1：注意運(yùn)算符的優(yōu)先級，并用括號明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級。說明：防止閱讀程序時產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級與設(shè)計(jì)思想不符而導(dǎo)致程序出錯。示例：下列語句中的表達(dá)式word=(high<<8)|low(1)if((a|b)&&(a&c))(2)if((a|b)<(c&d))(3)如果書寫為high<<8|lowa|b&&a&ca|b<c&d由于high<<8|low=(high<<8)|low,a|b&&a&c=(a|b)&&(a&c)，(1)(2)不會出錯，但語句不易理解；a|b<c&d=a|（b<c）&d，(3)造成了判斷條件出錯。4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識來替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替。示例：如下的程序可讀性差。if(Trunk[index].trunk_state==0){Trunk[index].trunk_state=1;...runk_state==TRUNK_IDLE){Trunk[index].trunk_state=TRUNK_BUSY;.....（從低到高，以字節(jié)為單位）examexam低字節(jié)exam高字節(jié)內(nèi)存：0bit1bit2bit...（字節(jié)的各“位”）EXAM_BITA1A2A3如下是68360CPU生成短整數(shù)及位域的方式。內(nèi)存：012...（從低到高，以字節(jié)為單位）examexam高字節(jié)exam低字節(jié)內(nèi)存：7bit6bit5bit...（字節(jié)的各“位”）EXAM_BITA1A2A3說明：在對齊方式下，CPU的運(yùn)行效率要快得多。示例：如下圖，當(dāng)一個long型數(shù)（如圖中l(wèi)ong1）在內(nèi)存中的位置正好與內(nèi)存的字邊界對齊時，CPU存取這個數(shù)只需訪問一次內(nèi)存，而當(dāng)一個long型數(shù)（如圖中的long2）在內(nèi)存中的位置跨越了字邊界時，CPU存取這個數(shù)就需要多次訪問內(nèi)存，如i960cx訪問這樣的數(shù)需讀內(nèi)存三次（一個BYTE、一個SHORT、一個BYTE，由CPU的微代碼執(zhí)行，對軟件透明），所有對齊方式下CPU的運(yùn)行效率明顯快多了。 18162432 |long1|long1|long1|long1| ||||long2| |long2|long2|long2|| |6函數(shù)、過程6-1：對所調(diào)用函數(shù)的錯誤返回碼要仔細(xì)、全面地處理。6-2：明確函數(shù)功能，精確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)。6-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操作）等手段對其加以保護(hù)。說明：若對所使用的全局變量不加以保護(hù)，則此函數(shù)就不具有可重入性，即當(dāng)多個進(jìn)程調(diào)用此函數(shù)時，很有可能使有關(guān)全局變量變?yōu)椴豢芍獱顟B(tài)。示例：假設(shè)Exam是int型全局變量，函數(shù)Squre_Exam返回Exam平方值。那么如下函數(shù)不具有可重入性。unsignedintexample(intpara){unsignedinttemp;Exam=para;.....yDataPtr，則可以通過以下宏定義來代替：#definepSOCKDATATheReceiveBuffer[FirstScoket].byDataPtr7可測性7-1：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，要有一套統(tǒng)一的為集成測試與系統(tǒng)聯(lián)調(diào)準(zhǔn)備的調(diào)測開關(guān)及相應(yīng)打印函數(shù)，并且要有詳細(xì)的說明。說明：本規(guī)則是針對項(xiàng)目組或產(chǎn)品組的。7-2：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，調(diào)測打印出的信息串的格式要有統(tǒng)一的形式。信息串中至少要有所在模塊名（或源文件名）及行號。說明：統(tǒng)一的調(diào)測信息格式便于集成測試。7-3：編程的同時要為單元測試選擇恰當(dāng)?shù)臏y試點(diǎn)，并仔細(xì)構(gòu)造測試代碼、測試用例，同時給出明確的注釋說明。測試代碼部分應(yīng)作為（模塊中的）一個子模塊，以方便測試代碼在模塊中的安裝與拆卸（通過調(diào)測開關(guān)）。說明：為單元測試而準(zhǔn)備。7-4：在進(jìn)行集成測試/系統(tǒng)聯(lián)調(diào)之前，要構(gòu)造好測試環(huán)境、測試項(xiàng)目及測試用例，同時仔細(xì)分析并優(yōu)化測試用例，以提高測試效率。說明：好的測試用例應(yīng)盡可能模擬出程序所遇到的邊界值、各種復(fù)雜環(huán)境及一些極端情況等。7-5：使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測性。說明：斷言是對某種假設(shè)條件進(jìn)行檢查（可理解為若條件成立則無動作，否則應(yīng)報告），它可以快速發(fā)現(xiàn)并定位軟件問題，同時對系統(tǒng)錯誤進(jìn)行自動報警。斷言可以對在系統(tǒng)中隱藏很深，用其它手段極難發(fā)現(xiàn)的問題進(jìn)行定位，從而縮短軟件問題定位時間，提高系統(tǒng)的可測性。實(shí)際應(yīng)用時，可根據(jù)具體情況靈活地設(shè)計(jì)斷言。示例：下面是C語言中的一個斷言，用宏來設(shè)計(jì)的。（其中NULL為0L）#ifdef_EXAM_ASSERT_TEST_.....ength;rect_width_sum+=rect[ind].width;}}因?yàn)榕袛嗾Z句與循環(huán)變量無關(guān)，故可如下改進(jìn)，以減少判斷次數(shù)。if