C語(yǔ)言代碼風(fēng)格課件

代碼規(guī)范

rulesandguidelinesofCodingStyle

——優(yōu)秀程序員的必備素質(zhì)

代碼規(guī)范

rulesandguidelinesofC關(guān)于代碼風(fēng)格問(wèn)題代碼風(fēng)格（CodingStyle）是一種習(xí)慣現(xiàn)在許多大公司都對(duì)員工書(shū)寫(xiě)代碼制定了規(guī)范開(kāi)發(fā)大項(xiàng)目時(shí)由項(xiàng)目管理者制定代碼規(guī)范BasicrulesandguidelinesofCodingStyle程序版式程序注釋命名規(guī)則SomeotherrulesandguidelinesofCodingStyle內(nèi)存管理關(guān)于代碼風(fēng)格問(wèn)題代碼風(fēng)格（CodingStyle）是一種習(xí)代碼總體原則清晰第一編寫(xiě)程序以人為本，計(jì)算機(jī)第二簡(jiǎn)潔為美代碼越長(zhǎng)，越難看懂，越容易出錯(cuò)，越難改錯(cuò)，可靠性越低重復(fù)代碼盡可能提煉成函數(shù)選擇合適的風(fēng)格，與代碼原有風(fēng)格保持一致重構(gòu)/修改其他的代碼時(shí)比較明智的做法代碼總體原則清晰第一程序版式程序版式——程序員的書(shū)法比書(shū)法好學(xué)得多，基本不需要特別練習(xí)但是壞習(xí)慣一旦養(yǎng)成，就像書(shū)法一樣難以改變不影響程序的功能，但影響程序的可讀性追求清晰、整潔、美觀、一目了然容易閱讀，容易測(cè)試程序版式程序版式——程序員的書(shū)法程序版式不良的風(fēng)格intisprime(intn){intk,i;if(n==1)return0;k=sqrt((double)n);for(i=2;i<=k;i++){if(n%i==0)return0;}return1;}#include<stdio.h>#include<math.h>main(){inti;for(i=2;i<100;i++){if(isprime(i))printf("%d\t",i);}}程序版式不良的風(fēng)格intisprime(intn)#in程序版式良好的風(fēng)格intisprime(intn){

intk,i; if(n==1)return0; k=(int)sqrt((double)n);

for(i=2;i<=k;i++){

if(n%i==0)

return0;}return1;}#include<stdio.h>#include<math.h>main(){

inti;

for(i=2;i<100;i++){

if(isprime(i))printf("%d\t",i);}}程序版式良好的風(fēng)格intisprime(intn)#in程序版式對(duì)齊（Alignment）與縮進(jìn)（indent）——保證代碼整潔、層次清晰的主要手段“{”位置的兩種風(fēng)格{和}獨(dú)占一行，且位于同一列，與引用它們的語(yǔ)句左對(duì)齊，便于檢查配對(duì)情況位于同一層{和}之內(nèi)的代碼在{右邊數(shù)格處左對(duì)齊，即同層次的代碼在同層次的縮進(jìn)層上可以用設(shè)置為4個(gè)空格的Tab鍵縮進(jìn)，盡量不用空格縮進(jìn)程序版式對(duì)齊（Alignment）與縮進(jìn)（indent）voidFunction(intx){

…//programcode}voidFunction(intx){…//programcode}if(condition){

…//programcode}else{

…//programcode}if(condition){…//programcode}else{…//programcode}for(initialization;condition;update){

…//programcode}for(initialization;condition;update){…//programcode}while(condition){

…//programcode}while(condition){…//programcode}如果出現(xiàn)嵌套的｛｝，則使用縮進(jìn)對(duì)齊，如：

{

… {

… }

…}建議的風(fēng)格不建議的風(fēng)格voidFunction(intx)voidFunct程序版式變量的對(duì)齊規(guī)則數(shù)據(jù)類(lèi)型+N個(gè)TAB+變量名+[N個(gè)TAB]+=+[初始化值];例charname[20];charaddr[30];charsex='F';intage=20;floatscore=90;程序版式變量的對(duì)齊規(guī)則程序版式空行——分隔程序段落的作用在每個(gè)類(lèi)聲明之后加空行在每個(gè)函數(shù)定義結(jié)束之后加空行在一個(gè)函數(shù)體內(nèi)，相鄰兩組邏輯上密切相關(guān)的語(yǔ)句塊之間加空行，語(yǔ)句塊內(nèi)不加空行//空行voidFunction1(…){…}//空行voidFunction2(…){…}//空行voidFunction3(…){…}//空行while(condition){ statement1; //空行

if(condition) { statement2; } else { statement3; }//空行

statement4;}程序版式空行——分隔程序段落的作用//空行//空行程序版式代碼行內(nèi)的空格——增強(qiáng)單行清晰度關(guān)鍵字之后加空格函數(shù)名之后不加空格賦值、算術(shù)、關(guān)系、邏輯等二元運(yùn)算符前后各加一空格，但一元運(yùn)算符前后一般不加空格sum=sum+term;(向后緊跟，),;向前緊跟，緊跟處不留空格,;后留一個(gè)空格Function(x,y,z)for(initialization;condition;update)[].->前后不加空格對(duì)表達(dá)式較長(zhǎng)的for和if語(yǔ)句，為了緊湊可在適當(dāng)?shù)胤饺サ粢恍┛崭駀or(i=0;i<10;i++)if((a+b>c)&&(b+c>a)&&(c+a>b))程序版式代碼行內(nèi)的空格——增強(qiáng)單行清晰度voidFunc1(intx,inty,intz);//良好的風(fēng)格voidFunc1(intx,inty,intz);//不良的風(fēng)格printf("%d%d%d",a,b,c);//良好的風(fēng)格printf("%d%d%d",a,b,c);//不良的風(fēng)格if(year>=2000)//良好的風(fēng)格if(year>=2000)//不良的風(fēng)格if((a>=b)&&(c<=d))//良好的風(fēng)格if(a>=b&&c<=d)//不良的風(fēng)格for(i=0;i<10;i++)//良好的風(fēng)格for(i=0;i<10;i++)//不良的風(fēng)格for(i=0;i<10;i++)//過(guò)多的空格x=a<b?a:b;//良好的風(fēng)格x=a<b?a:b;//不良的風(fēng)格int*x=&y;//良好的風(fēng)格int*x=&y;//不良的風(fēng)格array[5]=0;//不要寫(xiě)成array[5]=0;a.Function();//不要寫(xiě)成a.Function();b->Function();//不要寫(xiě)成b->Function();程序版式voidFunc1(intx,inty,intz程序版式代碼行一行只寫(xiě)一條語(yǔ)句，這樣方便測(cè)試一行只寫(xiě)一個(gè)變量，這樣方便寫(xiě)注釋intwidth;//寬度intheight;//高度intdepth;//深度盡可能在定義變量的同時(shí)，初始化該變量intsum=0;if、for、while、do等語(yǔ)句各占一行，執(zhí)行語(yǔ)句無(wú)論有幾條都用{和}將其包含在內(nèi)，這樣便于維護(hù)if(width<height){DoSomething();}//空行OtherThing();程序版式代碼行intwidth; //寬度intheight; //高度intdepth; //深度intwidth,height,depth;//寬度高度深度x=a+b;y=c+d;z=e+f;x=

a+b;y=c+d;z=e+f;if(width<height){dosomething();}if(width<height)dosomething();for(initialization;condition;update){dosomething();}//空行other();for(initialization;condition;update)dosomething();other();程序版式intwidth; //寬度intwidth,hei程序版式長(zhǎng)行拆分代碼行不宜過(guò)長(zhǎng)，應(yīng)控制在10個(gè)單詞或70-~80個(gè)字符以?xún)?nèi)Studiesshowthatuptoten-wordtextwidthsareoptimalforeyetracking實(shí)在太長(zhǎng)時(shí)要在適當(dāng)位置拆分，拆分出的新行要進(jìn)行適當(dāng)縮進(jìn)if((veryLongVar1>=veryLongVar2)&&(veryLongVar3>=veryLongVar4)){DoSomething();}doubleFunctionName(doublevariablename1,doublevariablename2);for(very_longer_initialization; very_longer_condition; very_longer_update){ DoSomething();}程序版式長(zhǎng)行拆分程序版式修飾符*和&的位置有爭(zhēng)議從語(yǔ)義上講，靠近數(shù)據(jù)類(lèi)型更直觀，但對(duì)多個(gè)變量聲明時(shí)容易引起誤解int*x,y;提倡靠近變量名int*x,y;程序版式修飾符*和&的位置標(biāo)識(shí)符命名規(guī)則按照?qǐng)?zhí)行級(jí)別分為：共性規(guī)則必須執(zhí)行簡(jiǎn)化規(guī)則建議采用可選規(guī)則靈活運(yùn)用標(biāo)識(shí)符命名規(guī)則按照?qǐng)?zhí)行級(jí)別分為：標(biāo)識(shí)符命名的共性規(guī)則直觀可以拼讀，見(jiàn)名知意，不必解碼最好采用英文單詞或其組合，切忌用漢語(yǔ)拼音盡量避免出現(xiàn)數(shù)字編號(hào)不要出現(xiàn)僅靠大小寫(xiě)區(qū)分的相似的標(biāo)識(shí)符不要出現(xiàn)名字完全相同的局部變量和全局變量標(biāo)識(shí)符命名的共性規(guī)則直觀可以拼讀，見(jiàn)名知意，不必解碼標(biāo)識(shí)符命名的共性規(guī)則用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)intminValue;intmaxValue;intGetValue(…);intSetValue(…);標(biāo)識(shí)符命名的共性規(guī)則用正確的反義詞組命名具有互斥意義的變量或標(biāo)識(shí)符命名的共性規(guī)則盡量與所采用的操作系統(tǒng)或開(kāi)發(fā)工具的風(fēng)格保持一致駝峰命名法帕斯卡命名法匈牙利命名法在Linux/Unix平臺(tái)習(xí)慣用“小寫(xiě)加下劃線”function_name

variable_NameWindows風(fēng)格大小寫(xiě)混排的單詞組合而成FunctionName

variableName標(biāo)識(shí)符命名的共性規(guī)則盡量與所采用的操作系統(tǒng)或開(kāi)發(fā)工具的風(fēng)格保Windows應(yīng)用程序命名規(guī)則Microsoft公司的HungarianNotation（匈牙利命名法）主要思想在變量和函數(shù)名前加上前綴，用于標(biāo)識(shí)變量的數(shù)據(jù)類(lèi)型[限定范圍的前綴]+[數(shù)據(jù)類(lèi)型前綴]+[有意義的英文單詞]限定范圍的前綴靜態(tài)變量前加前綴s_，表示static全局變量前加前綴g_，表示global類(lèi)內(nèi)的成員函數(shù)m_默認(rèn)情況為局部變量數(shù)據(jù)類(lèi)型前綴ch字符變量前綴i整型變量前綴f實(shí)型變量前綴p指針變量前綴Windows應(yīng)用程序命名規(guī)則Microsoft公司的HunWindows應(yīng)用程序命名規(guī)則缺點(diǎn)煩瑣例如inti,j,k;floatx,y,z;若采用匈牙利命名規(guī)則，則應(yīng)寫(xiě)成intiI,iJ,ik;//前綴i表示int類(lèi)型floatfX,fY,fZ;//前綴f表示float類(lèi)型Windows應(yīng)用程序命名規(guī)則缺點(diǎn)簡(jiǎn)化的Windows應(yīng)用程序命名規(guī)則變量名形式小寫(xiě)字母開(kāi)頭“名詞”或者“形容詞+名詞”如oldValue,newValue等函數(shù)名形式大寫(xiě)字母開(kāi)頭“動(dòng)詞”或者“動(dòng)詞+名詞”（動(dòng)賓詞組）如GetValue(),SetValue()等宏和const常量全用大寫(xiě)字母，并用下劃線分割單詞#define

ARRAY_LEN10constint

MAX_LEN=100;簡(jiǎn)化的Windows應(yīng)用程序命名規(guī)則變量名形式靈活運(yùn)用的命名規(guī)則限定范圍的前綴與數(shù)據(jù)類(lèi)型前綴可要可不要無(wú)特殊意義的循環(huán)變量可以直接定義成i,j,k等單字母變量靈活運(yùn)用的命名規(guī)則限定范圍的前綴與數(shù)據(jù)類(lèi)型前綴可要可不要注釋規(guī)范注釋?zhuān)–omments）的重要性寫(xiě)注釋給誰(shuí)看？在哪些地方寫(xiě)注釋?zhuān)吭鯓訉?xiě)注釋?zhuān)孔⑨尩娘L(fēng)格寫(xiě)注釋時(shí)的注意事項(xiàng)可靈活運(yùn)用的一些規(guī)則注釋規(guī)范注釋?zhuān)–omments）的重要性注釋規(guī)范注釋的重要性注釋對(duì)于程序猶如眼睛對(duì)于人的重要性一樣沒(méi)有注釋的程序?qū)τ谧x者好比眼前一團(tuán)漆黑，跟拿到一個(gè)可執(zhí)行程序別無(wú)二致不規(guī)范的注釋和好幾千度的近視眼沒(méi)什么區(qū)別代碼本身體現(xiàn)不出價(jià)值開(kāi)發(fā)程序的思維才能使其變得有價(jià)值這種思維的具體體現(xiàn)就是在于注釋和規(guī)范的代碼本身注釋規(guī)范注釋的重要性注釋規(guī)范寫(xiě)注釋給誰(shuí)看？給自己看，使自己的設(shè)計(jì)思路得以連貫給繼任者看，使其能夠接替自己的工作注釋規(guī)范寫(xiě)注釋給誰(shuí)看？注釋規(guī)范寫(xiě)注釋的最重要的功效在于傳承要站在繼任者的角度寫(xiě)簡(jiǎn)單明了、準(zhǔn)確易懂、防止二義性讓繼任者可以輕松閱讀、復(fù)用、修改自己的代碼讓繼任者輕松辨別出哪些使自己寫(xiě)的，哪些是別人寫(xiě)的注釋規(guī)范寫(xiě)注釋的最重要的功效在于傳承注釋規(guī)范不好的注釋i=i+1; //i加1return-1;//返回-1free(p); //釋放p所指的內(nèi)存fclose(fin); //關(guān)閉文件注釋規(guī)范不好的注釋注釋規(guī)范不好的注釋不但白寫(xiě)，還擾亂了讀者的視線/*以二進(jìn)制只讀方式打開(kāi)文件并判斷打開(kāi)是否成功*/if((fin=fopen("cat.pic","rb")==NULL){puts("打開(kāi)文件cat.pic失敗");/*如果打開(kāi)失敗，則顯示錯(cuò)誤信息*/

return-1;/*返回-1*/}……/*從圖像的第1行到第400行循環(huán)*/for(i=0;i<400;i++)/*從圖像的第1列到第400列循環(huán)*/

for(j=0;j<400;j++){……/*按照公式Y(jié)=0.299*R+0.587*G+0.114*B計(jì)算灰度值*/y=(299*r+587*g+114*b)/1000;……}……fclose(fin);/*關(guān)閉文件*/注釋規(guī)范不好的注釋不但白寫(xiě)，還擾亂了讀者的視線注釋規(guī)范好的注釋?zhuān)ㄓ绕涫撬惴ㄗ⑨專(zhuān)┦菍?duì)設(shè)計(jì)思想的精確表述和清晰展現(xiàn)，能揭示代碼背后隱藏的重要信息/*打開(kāi)輸入文件后判斷文件長(zhǎng)度是否符合格式要求*/if((fin=fopen("cat.pic","rb")==NULL){puts("打開(kāi)文件cat.pic失敗");

return-1;}……/**下面是圖像轉(zhuǎn)換的算法實(shí)現(xiàn)。彩色圖像到灰度圖像的轉(zhuǎn)換主要利用RGB顏色空間到*YUV顏色空間的變換公式來(lái)取得灰度值，公式為Y=0.299*R+0.587*G+0.114*B*/for(i=0;i<400;i++)

for(j=0;j<400;j++){……y=(299*r+587*g+114*b)/1000;……}……fclose(fin);注釋規(guī)范好的注釋?zhuān)ㄓ绕涫撬惴ㄗ⑨專(zhuān)┦菍?duì)設(shè)計(jì)思想的精確表述和清注釋規(guī)范在哪些地方寫(xiě)注釋?zhuān)吭谥匾奈募撞课募?功能說(shuō)明+[作者]+[版本]+[版權(quán)聲明]+[日期]在用戶(hù)自定義函數(shù)前對(duì)函數(shù)接口進(jìn)行說(shuō)明函數(shù)功能+入口參數(shù)+出口參數(shù)+返回值（包括出錯(cuò)處理）在一些重要的語(yǔ)句塊上方對(duì)代碼的功能、原理進(jìn)行解釋說(shuō)明注釋規(guī)范在哪些地方寫(xiě)注釋?zhuān)孔⑨屢?guī)范在一些重要的語(yǔ)句行右方定義一些非通用的變量函數(shù)調(diào)用較長(zhǎng)的、多重嵌套的語(yǔ)句塊結(jié)束處在修改的代碼行旁邊加注釋注釋規(guī)范在一些重要的語(yǔ)句行右方注釋規(guī)范函數(shù)的注釋風(fēng)格C風(fēng)格/**********************************************/ /*功能描述：本函數(shù)用于實(shí)現(xiàn)xxx功能，目的是： *//*入口參數(shù)：參數(shù)xx，表示 *//*出口參數(shù)：參數(shù)xx，表示 *//*返回值：返回xx值，當(dāng)返回xx值時(shí)，表示 */ /**********************************************//*功能描述：本函數(shù)用于實(shí)現(xiàn)xxx功能，目的是：

入口參數(shù)：參數(shù)xx，表示

出口參數(shù)：參數(shù)xx，表示

返回值：返回xx值，當(dāng)返回xx值時(shí)，表示

*/C++風(fēng)格//////////////////////////////////////////

//功能描述：本函數(shù)用于實(shí)現(xiàn)xxx功能，目的是：//入口參數(shù)：參數(shù)xx，表示 //出口參數(shù)：參數(shù)xx，表示 //返回值：返回xx值，當(dāng)返回xx值時(shí)，表示

//////////////////////////////////////////注釋規(guī)范函數(shù)的注釋風(fēng)格注釋規(guī)范一塊語(yǔ)句的注釋風(fēng)格/* *C風(fēng)格 */C風(fēng)格/********************************/ /*下面代碼是用來(lái)接收網(wǎng)絡(luò)數(shù)據(jù)，其原理為*/ /*……*/ /********************************/////////////////////////////////// //VisualC++風(fēng)格// //////////////////////////////////注釋規(guī)范一塊語(yǔ)句的注釋風(fēng)格注釋規(guī)范一行語(yǔ)句的注釋風(fēng)格/*C風(fēng)格*///VisualC++風(fēng)格i=j+1;//代碼行右方的注釋//代碼行之上的注釋 i=j+1;例子ResetSrollInfo(g_hwndThumb);//初始化滾動(dòng)條位置for循環(huán) { while循環(huán) { if() {……}//if結(jié)束 }//while結(jié)束 }//for結(jié)束注釋規(guī)范一行語(yǔ)句的注釋風(fēng)格注釋規(guī)范可靈活運(yùn)用的一些規(guī)則注釋可長(zhǎng)可短，但應(yīng)畫(huà)龍點(diǎn)睛，重點(diǎn)加在語(yǔ)義轉(zhuǎn)折處簡(jiǎn)單的函數(shù)可以用一句話簡(jiǎn)單說(shuō)明//兩數(shù)交換voidSwap(int*x,int*y)內(nèi)部使用的函數(shù)可以簡(jiǎn)單注釋?zhuān)﹦e人使用的函數(shù)必須嚴(yán)格注釋?zhuān)貏e是入口參數(shù)和出口參數(shù)注釋規(guī)范可靈活運(yùn)用的一些規(guī)則注釋規(guī)范寫(xiě)注釋時(shí)的注意事項(xiàng)注釋不是白話文翻譯，不要鸚鵡學(xué)舌Don'twritecommentsthatrepeatthecode注釋不是教科書(shū)，不要把別人當(dāng)成初學(xué)者注釋不是標(biāo)準(zhǔn)庫(kù)函數(shù)參考手冊(cè)注釋不是越多越好，不好的注釋等于垃圾不寫(xiě)做了什么，寫(xiě)想做什么Dowriteilluminatingcommentsthatexplainapproachandrationale邊寫(xiě)代碼邊注釋修改代碼同時(shí)修改注釋注釋規(guī)范寫(xiě)注釋時(shí)的注意事項(xiàng)函數(shù)規(guī)范一個(gè)函數(shù)僅僅完成一件功能不好的例子：內(nèi)存泄露的情形Char*buffer=(char*)malloc(***_SIZE);Buffer=(char*)realloc(buffer,NEW_SIZE);一個(gè)函數(shù)代碼行數(shù)不要超過(guò)100行重復(fù)代碼盡可能提煉成函數(shù)降低維護(hù)成本代碼塊嵌套深度不超過(guò)4層函數(shù)規(guī)范一個(gè)函數(shù)僅僅完成一件功能函數(shù)規(guī)范避免使用全局變量下面例子結(jié)果可能是未知的intg_exam;

Unsignedint

example(

int

para

)

{

unsigned

inttemp;

g_exam

=

para;

//

（**）