C語言代碼規(guī)范

C語言編程規(guī)范目錄排版1注釋2標(biāo)識符命名3程序可讀性4程序效率5內(nèi)存管理6宏定義7其它81-1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)一般為4個。1-2：相對獨(dú)立的程序塊之間，變量說明之后要加空行。一、排版示例：如下例子不符合規(guī)范。if(!valid_ni(ni)){...//programcode}repssn_ind=

ssn_data[index].repssn_index;應(yīng)如下書寫if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_index;1-3：程序塊的分界符（如‘{’和‘}’）應(yīng)各自獨(dú)占一行并且位于同一列，同時與引用它們的語句左對齊。一、排版示例：不推薦for(...){...//programcode}if(...){...//programcode}推薦寫法for(...){...//programcode}if(...){...//programcode}1-4：不要把多個短語句寫在一行中，即一行只寫一條語句。示例：如下例子不符合規(guī)范。rect.length=0;rect.width=0;應(yīng)如下書寫rect.length=0;rect.width=0;1-5：if、for、do、while、case、switch、default等語句要各自占一行，且if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號{}。示例：如下例子不符合規(guī)范。if(pUserCR==NULL)return;應(yīng)如下書寫：if(pUserCR==NULL){ return;}一、排版1-6：較長的語句（>80字符）要分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(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_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));一、排版說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準(zhǔn)確、易懂、簡潔。2-1：文件頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、修改日志等。示例：/***************************************************************************Copyright:1988-1999,HuaweiTech.Co.,Ltd.Filename:文件名Description:用于詳細(xì)說明此程序文件完成的主要功能，與其他模塊或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系A(chǔ)uthor:作者Version:版本Date:完成日期History:修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡述。*****************************************************************************/二、注釋2-2：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。示例：/*************************************************Function://函數(shù)名稱Description://函數(shù)功能、性能等的描述Calls://被本函數(shù)調(diào)用的函數(shù)清單CalledBy://調(diào)用本函數(shù)的函數(shù)清單TableAccessed://被訪問的表（此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序）TableUpdated://被修改的表（此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序）Input://輸入?yún)?shù)說明，包括每個參數(shù)的作//用、取值說明及參數(shù)間關(guān)系。Output://對輸出參數(shù)的說明。Return://函數(shù)返回值的說明Others://其它說明*************************************************/二、注釋2-3：一般情況下，源程序有效注釋量必須在20％以上。2-4：邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。2-5：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。2-6：注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方。2-7：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋放在此域的右方。2-8：全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項(xiàng)等的說明。、2-9：注釋與所描述內(nèi)容進(jìn)行同樣的縮排。2-10：避免在一行代碼或表達(dá)式的中間插入注釋。2-11：注釋格式盡量統(tǒng)一，建議使用“/*??*/”。二、注釋3-1：標(biāo)識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。示例：如下單詞的縮寫能夠被大家基本認(rèn)可。temp可縮寫為tmpflag可縮寫為flgstatistic可縮寫為statbuffer可縮寫為bufmessage可縮寫為msg3-2：對于變量命名，禁止取單個字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。3-3：除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識符。示例：如下命名，使人產(chǎn)生疑惑。#define_EXAMPLE_0_TEST_#define_EXAMPLE_1_TEST_應(yīng)改為有意義的單詞命名#define_EXAMPLE_FAIL_TEST_#define_EXAMPLE_PASS_TEST_三、標(biāo)識符命名3-4：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，

防止編譯、鏈接時產(chǎn)生沖突。3-5：用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。說明：下面是一些在軟件中常用的反義詞組。add/removebegin/end up/downinsert/deletefirst/lastget/releaseopen/closeput/get start/stoplock/unlockmin/maxshow/hideold/newnext/previousincrement/decrementsource/targetsend/receivecreate/destroysource/destinationcut/paste示例：intmin_sum;intmax_sum;intadd_user(BYTE*user_name);intdelete_user(BYTE*user_name);三、標(biāo)識符命名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;...//programcode}應(yīng)改為如下形式。#defineTRUNK_FAIL0#defineTRUNK_PASS1if(Trunk[index].trunk_state==TRUNK_FAIL){Trunk[index].trunk_state=TRUNK_PASS;...//programcode}4-3：源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰四、可讀性示例：以下代碼布局不太合理。rect.length=10;char_poi=str;rect.width=5;若按如下形式書寫，可能更清晰一些。rect.length=10;rect.width=5;//矩形的長與寬關(guān)系較密切，放在一起。char_poi=str;4-4：不要使用難懂的技巧性很高的語句，除非很有必要時。示例：如下表達(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;”5-1：通過對系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進(jìn)，以及對程序算法的優(yōu)化來提高空間效率。五、程序效率示例：如下記錄學(xué)生學(xué)習(xí)成績的結(jié)構(gòu)不合理。typedefunsignedcharBYTE;typedefunsignedshortWORD;typedefstructSTUDENT_SCORE_STRU{BYTEname[8];BYTEage;BYTEsex;BYTEclass;BYTEsubject;floatscore;}STUDENT_SCORE;因?yàn)槊课粚W(xué)生都有多科學(xué)習(xí)成績，故如上結(jié)構(gòu)將占用較大空間。應(yīng)如下改進(jìn)（分為兩個結(jié)構(gòu)），總的存貯空間將變小，操作也變得更方便。typedefstructSTUDENT_STRU{BYTEname[8];BYTEage;BYTEsex;BYTEclass;}STUDENT;typedefstructSTUDENT_SCORE_STRU{WORDstudent_index;BYTEsubject;floatscore;}STUDENT_SCORE;5-2：在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層。五、程序效率示例：如下代碼效率不高。for(row=0;row<100;row++){for(col=0;col<5;col++){sum+=a[row][col];}}可以改為如下方式，以提高效率。for(col=0;col<5;col++){for(row=0;row<100;row++){sum+=a[row][col];}}6-3：循環(huán)體內(nèi)工作量最小化。示例：如下代碼效率不高。for(ind=0;ind<MAX_ADD_NUMBER;ind++){sum+=ind;back_sum=sum;}語句“back_sum=sum;”完全可以放在for語句之后，如下。for(ind=0;ind<MAX_ADD_NUMBER;ind++){sum+=ind;}back_sum=sum;/*backupsum*/5-4：通過對系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進(jìn)，以及對程序算法的優(yōu)化來提高空間效率。五、程序效率for(ind=0;ind<MAX_RECT_NUMBER;ind++){if(data_type==RECT_AREA){area_sum+=rect_area[ind];}else{rect_length_sum+=rect[ind].length;rect_width_sum+=rect[ind].width;}}因?yàn)榕袛嗾Z句與循環(huán)變量無關(guān)，故可如下改進(jìn)，以減少判斷次數(shù)。if(data_type==RECT_AREA){for(ind=0;ind<MAX_RECT_NUMBER;ind++){area_sum+=rect_area[ind];}}else{for(ind=0;ind<MAX_RECT_NUMBER;ind++){rect_length_sum+=rect[ind].length;rect_width_sum+=rect[ind].width;}}5-5：不應(yīng)花過多的時間拼命地提高調(diào)用不很頻繁的函數(shù)代碼效率。5-6：在保證程序質(zhì)量的前提下，通過壓縮代碼量、去掉不必要代碼以及減少不必要的局部和全局變量，來提高空間效率。5-7：盡量減少循環(huán)嵌套層次。5-8：局部效率應(yīng)為全局效率服務(wù)，不能因?yàn)樘岣呔植啃识鴮θ中试斐捎绊憽?-9：不要一味追求緊湊的代碼。5-10：盡量用乘法或其它方法代替除法，特別是浮點(diǎn)運(yùn)算中的除法。示例：如下表達(dá)式運(yùn)算可能要占較多CPU資源。#definePAI3.1416radius=circle_length/(2*PAI);應(yīng)如下把浮點(diǎn)除法改為浮點(diǎn)乘法。#definePAI_RECIPROCAL(1/3.1416)//編譯器編譯時，將生成具體浮點(diǎn)數(shù)radius=circle_length*PAI_RECIPROCAL/2;五、程序效率6-1：過程/函數(shù)中申請的（為打開文件而使用的）文件句柄，在過程/函數(shù)退出之前要關(guān)閉。六、內(nèi)存操作示例：下函數(shù)在退出之前，沒有把分配的內(nèi)存釋放。typedefunsignedcharBYTE;intexample_fun(BYTEgt_len,BYTE*gt_code){BYTE*gt_buf;gt_buf=(BYTE*)malloc(MAX_GT_LENGTH);if(gt_len>MAX_GT_LENGTH){returnGT_LENGTH_ERROR;//忘了釋放gt_buf}...//otherprogramcode}應(yīng)改為如下。intexample_fun(BYTEgt_len,BYTE*gt_code){BYTE*gt_buf;gt_buf=(BYTE*)malloc(MAX_GT_LENGTH);if(gt_len>MAX_GT_LENGTH){free(gt_buf);//退出之前釋放gt_bufreturnGT_LENGTH_ERROR;}...//otherprogramcode}6-2：防止內(nèi)存操作越界。說明：內(nèi)存操作主要是指對數(shù)組、指針、內(nèi)存地址等的操作。內(nèi)存操作越界是軟件系統(tǒng)主要錯誤之一，后果往往非常嚴(yán)重，所以當(dāng)我們進(jìn)行這些操作時一定要仔細(xì)小心。六、內(nèi)存操作示例：假設(shè)某軟件系統(tǒng)最多可由10個用戶同時使用，用戶號為1-10，那么如下程序存在問題。#defineMAX_USR_NUM10unsignedcharusr_login_flg[MAX_USR_NUM]="";voidset_usr_login_flg(unsignedcharusr_no){if(!usr_login_flg[usr_no]){usr_login_flg[usr_no]=TRUE;}}當(dāng)usr_no為10時，將使用usr_login_flg越界?？刹捎萌缦路绞浇鉀Q。voidset_usr_login_flg(unsignedcharusr_no){if(!usr_login_flg[usr_no-1]){usr_login_flg[usr_no-1]=TRUE;}}7-1：用宏定義表達(dá)式時，要使用完備的括號。七、宏定義示例：如下定義的宏都存在一定的風(fēng)險。#defineRECTANGLE_AREA(a,b)a*b#defineRECTANGLE_AREA(a,b)(a*b)#defineRECTANGLE_AREA(a,b)(a)*(b)正確的定義應(yīng)為：#defineRECTANGLE_AREA(a,b)((a)*(b))7-2:使用宏時，不允許參數(shù)發(fā)生變化。示例：如下用法可能導(dǎo)致錯誤。#defineSQUARE(a)((a)*(a))inta=5;intb;b=SQUARE(a++);//結(jié)果：a=7，即執(zhí)行了兩次增1。正確的用法是：b=SQUARE(a);a++;//結(jié)果：a=6，即只執(zhí)行了一次增1。7-3:將宏所定義的多條表達(dá)式放在大括號中。示例：下面的語句只有宏的第一條表達(dá)式被執(zhí)行。為了說明問題，for語句的書寫稍不符范。七、宏定于#defineINTI_RECT_VALUE(a,b)\a=0;\b=0;for(index=0;index<RECT_TOTAL_NUM;index++)INTI_RECT_VALUE(rect.a,rect.b);正確的用法應(yīng)為：#defineINTI_RECT_VALUE(a,b)\{\a=0;\b=0;\}for(index=0;index<RECT_TOTAL_NUM;index++){INTI_RECT_VALUE(rect[index].a,rect[index].b);}

1.基本要求

1.1程序結(jié)構(gòu)清析，簡單易懂，單個函數(shù)的程序行數(shù)不得超過100行。1.2打算干什么，要簡單，直接了當(dāng)，代碼精簡，避免垃圾程序。

1.3盡量使用標(biāo)準(zhǔn)庫函數(shù)和公共函數(shù)。

1.4不要隨意定義全局變量，盡量使用局部變量。1.5使用括號以避免二義性。

2.可讀性要求

2.1可讀性第一，效率第二。

2.2保持注釋與代碼完全一致。

2.3每個源程序文件，都有文件頭說明，說明規(guī)格見規(guī)范。

2.4每個函數(shù)，都有函數(shù)頭說明，說明規(guī)格見規(guī)范。2.5主要變量（結(jié)構(gòu)、聯(lián)合、類或?qū)ο螅┒x或引用時，注釋能反映其含義。

2.6常量定義（DEFINE）有相應(yīng)說明。2.7處理過程的每個階段都有相關(guān)注釋說明。2.8在典型算法前都有注釋。2.9利用縮進(jìn)來顯示程序的邏輯結(jié)構(gòu)，縮進(jìn)量一致并以Tab鍵為單位，定義Tab為6個字節(jié)。八、其它

2.10循環(huán)、分支層次不要超過五層。

2.11注釋可以與