游戲軟件測試10課件

游戲軟件測試主講人：徐麗第四章

編碼規(guī)范

一、排版

1、程序塊要縮進程序塊要采用縮進風(fēng)格編寫，縮進的空格數(shù)為4個。說明：對于由開發(fā)工具自動生成的代碼可以有不一致。2、獨立塊之間要空行相對獨立的程序塊之間、變量說明之后必須加空行。示例1：以下例子不符合規(guī)范。voidFunction1(...){...//programcode}voidFunction2(...){ ...//programcode}應(yīng)如下書寫：voidFunction1(...){ ...//programcode}//空行voidFunction2(...){ ...//programcode}示例2：以下例子不符合規(guī)范。intm,n;m=10;n=20;應(yīng)如下書寫：intm,n;

//空行m=10;n=20;3、較長語句劃分新行較長的語句（>80字符）要分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當(dāng)?shù)目s進，使排版整齊，語句可讀。示例：permCountMsg.head.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(UL);actTaskTable[frameId*STAT_TASK_CHECK_NUMBER+index].occupied =statPoi[index].occupied;

actTaskTable[taskno].durationTrueOrFalse=SYSGetSccpStatisticState(statItem);

reportOrNotFlag=((taskno<MAX_ACT_TASK_NUMBER)&&(n7statStatItemValid(statItem))&&(actTaskTable[taskno].resultData!=0));4、較長表達(dá)式劃分新行循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進行適應(yīng)的劃分，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。示例：if((year%4==0)&&(year%100!=0) ||(year%400==0)){ ...//programcode}for(i=0,j=0;(i<firstWordLength) &&(j<secondWordLength);i++,j++){ ...//programcode}

for(i=0,j=0;(i<firstWordLength)&&(j<secondWordLength); i++,j++){ ...//programcode}5、較長參數(shù)適當(dāng)劃分若函數(shù)或過程中的參數(shù)較長，則要進行適當(dāng)?shù)膭澐?。示例：doubleBoxVolume(doublelength,doublewidth,doubleheight);6、一行只寫一條語句不允許把多個短語句寫在一行中，即一行只寫一條語句。示例1：以下例子不符合規(guī)范。intlength,width,height; //長度，寬度，高度

應(yīng)如下書寫：

intlength; //長度

intwidth; //寬度

intheight; //高度也可如下書寫：intlength, //長度

width, //寬度

height; //高度

示例2：以下例子不符合規(guī)范。length=0;width=0;height=0;

應(yīng)如下書寫：length=0;width=0;height=0;7、語句關(guān)鍵字占一行if、for、do、while、case、switch、default等關(guān)鍵字語句自占一行，且if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號{}。示例1：如下例子不符合規(guī)范。

if(n<0)return;

應(yīng)如下書寫：

if(n<0){ return;}示例2：如下例子不符合規(guī)范。for(i=1;i<=100;i++)sum+=i;

應(yīng)如下書寫：for(i=1;i<=100;i++){ sum+=i;}示例3：如下例子不符合規(guī)范。while(i<=100)i++;應(yīng)如下書寫：while(i<=100){ i++;}8、對齊只使用空格鍵對齊只使用空格鍵，不使用TAB鍵。說明：以免用不同的編輯器閱讀程序時，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因為BC會自動將8個空格變?yōu)橐粋€TAB鍵，因此使用BC合入的版本大多會將縮進變亂。9、縮進風(fēng)格函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風(fēng)格，case語句下的情況處理語句也要遵從語句縮進要求。10、分界符{}獨占一行程序塊的分界符（如C/C++語言的大括號‘{’和‘}’）應(yīng)各獨占一行并且位于同一列，同時與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進方式。示例：如下例子不符合規(guī)范。for(...){ ...//programcode}

if(...) { ...//programcode }

voidExampleFun(void) { ...//programcode }應(yīng)如下書寫：for(...){ ...//programcode}

if(...){ ...//programcode}

voidExampleFun(void){ ...//programcode}11、對等操作在兩個以上的關(guān)鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之后或者前后要加空格；進行非對等操作時，如果是關(guān)系密切的立即操作符（如->），后不應(yīng)加空格。說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。由于留空格所產(chǎn)生的清晰性是相對的，所以，在已經(jīng)非常清晰的語句中沒有必要再留空格，如果語句已足夠清晰則括號內(nèi)側(cè)(即左括號后面和右括號前面)不需要加空格，多重括號間不必加空格，因為在C/C++語言中括號已經(jīng)是最清晰的標(biāo)志了。在長語句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。給操作符留空格時不要連續(xù)留兩個以上空格。示例：(1)逗號、分號只在后面加空格。inta,b,c;

(2)比較操作符,賦值操作符"="、"+="，算術(shù)操作符"+"、"%"，邏輯操作符"&&"、"&"，位域操作符"<<"、"^"等雙目操作符的前后加空格。if(currentTime>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;

(3)“!”、“++”、“--"、"*"（內(nèi)容操作符）、"&"（地址運算符）等單目操作符前后不加空格。char*name,ch; //"*"緊靠變量名name，此處ch不會被誤解為指針*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)12、一行字符不要寫得過長

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

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

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

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

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

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

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

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

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

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

FileName:test.c Author:Version:Date: Description://模塊描述

Version://版本信息

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

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

<author><time><version><desc> David2003/10/121.0buildthismoudle

****************************************************/說明：Description一項描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡述。4、對函數(shù)頭部的注釋函數(shù)頭部應(yīng)進行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。示例：下面這段函數(shù)的注釋比較標(biāo)準(zhǔn)，當(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://其它說明*************************************************/5、邊寫代碼邊注釋邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。6、注釋的內(nèi)容注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。說明：錯誤的注釋不但無益反而有害。7、避免在注釋中使用縮寫避免在注釋中使用縮寫，特別是非常用縮寫。說明：在使用縮寫時或之前，應(yīng)對縮寫進行必要的說明。8、對代碼的注釋注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。示例：如下例子不符合規(guī)范。例1：/*getreplicatesubsystemindexandnetindicator*/ //空行

//空行repssnInd=ssnData[index].repssnIndex;repssnNi=ssnData[index].ni;例2：repssnInd=ssnData[index].repssnIndex;repssnNi=ssnData[index].ni;/*getreplicatesubsystemindexandnetindicator*/應(yīng)如下書寫：/*getreplicatesubsystemindexandnetindicator*/repssnInd=ssnData[index].repssnIndex;repssnNi=ssnData[index].ni;9、對變量、常量的注釋對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。示例：/*activestatistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/10、對數(shù)據(jù)結(jié)構(gòu)聲明的注釋數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋放在此域的右方。示例：可按如下形式說明枚舉/結(jié)構(gòu)/聯(lián)合。/*sccpinterfacewithsccpuserprimitivemessagename*/enumSCCP_USER_PRIMITIVE{ N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/ N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/ /*transmissionthismessage*/ N_UNITDATA_REQ/*sccpuser'sunitdatatransmissionrequest*/};

11、對全局變量的注釋全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。示例：/*TheErrorCodewhenSCCPtranslate*//*GlobalTitlefailure,asfollows*///變量作用、含義/*0－SUCCESS1－GTTableerror*//*2－GTerrorOthers－nouse*///變量取值范圍/*onlyfunctionSCCPTranslate()in*//*thismodualcanmodifyit,andother*//*modulecanvisititthroughcall*//*thefunctionGetGTTransErrorCode()*///使用方法charg_GTTranErrorCode;12、注釋的縮排注釋與所描述內(nèi)容進行同樣的縮排。說明：可使程序排版整齊，并方便注釋的閱讀與理解。示例:如下例子,排版不整齊,閱讀稍感不方便。voidExampleFun(void){/*codeonecomments*/

CodeBlockOne //空行

/*codetwocomments*/

CodeBlockTwo}

應(yīng)改為如下布局。voidExampleFun(void){ /*codeonecomments*/

CodeBlockOne //空行

/*codetwocomments*/

CodeBlockTwo}13、注釋與代碼用空行隔開將注釋與其上面的代碼用空行隔開。示例：如下例子，顯得代碼過于緊湊。

/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo

應(yīng)如下書寫/*codeonecomments*/programcodeone //空行/*codetwocomments*/programcodetwo14、必須編寫的注釋。對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護人員來說，良好的注釋幫助更好的理解程序，有時甚至優(yōu)于看設(shè)計文檔。15、對case語句的注釋對于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: