軟件編程規(guī)范和范例

軟件編程規(guī)范和范例通唐軟件技術(shù)新員工入職培訓(xùn)之通唐軟件技術(shù)(湖南)有限公司提綱⒈排版⒉注釋⒊標(biāo)識(shí)符命名⒋可讀性⒌變量、結(jié)構(gòu)⒍函數(shù)、過程⒎可測(cè)性⒏程序效率⒐質(zhì)量保證⒑代碼編輯、編譯、審查⒒代碼測(cè)試、維護(hù)⒓宏通唐軟件技術(shù)(湖南)有限公司⒈排版1-1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個(gè)說明：對(duì)于由開發(fā)工具自動(dòng)生成的代碼可以有不一致。通唐軟件技術(shù)(湖南)有限公司⒈排版1-2：相對(duì)獨(dú)立的程序塊之間、變量說明之后必須加空行示例：如下例子不符合規(guī)范。Intni;if(!valid_ni(ni)){

...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni

=ssn_data[index].ni;應(yīng)如下書寫Intni;

if(!valid_ni(ni)){

...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni

=ssn_data[index].ni;通唐軟件技術(shù)(湖南)有限公司⒈排版1-3：較長(zhǎng)的語(yǔ)句（>80字符）要分成多行書寫，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀示例：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));通唐軟件技術(shù)(湖南)有限公司⒈排版1-4：循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首示例：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}通唐軟件技術(shù)(湖南)有限公司⒈排版1-5：若函數(shù)或過程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(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);通唐軟件技術(shù)(湖南)有限公司⒈排版1-6：不允許把多個(gè)短語(yǔ)句寫在一行中，即一行只寫一條語(yǔ)句示例：如下例子不符合規(guī)范。rect.length=0;

rect.width=0;應(yīng)如下書寫rect.length=0;rect.width

=0;通唐軟件技術(shù)(湖南)有限公司⒈排版1-7：if、for、do、while、case、switch、default等語(yǔ)句自占一行，且if、for、do、while等語(yǔ)句的執(zhí)行語(yǔ)句部分無論多少都要加括號(hào){}示例：如下例子不符合規(guī)范。if(pUserCR==NULL)return;應(yīng)如下書寫：if(pUserCR==NULL){

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

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

{

...//programcode

}voidexample_fun(void)

{

...//programcode

}通唐軟件技術(shù)(湖南)有限公司⒈排版應(yīng)如下書寫。for(...){

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

...//programcode}voidexample_fun(void){

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

(2)比較操作符,賦值操作符"="、

"+="，算術(shù)操作符"+"、"%"，邏輯操作符"&&"、"&"，位域操作符"<<"、"^"等雙目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;(3)"!"、"~"、"++"、"--"、"&"（地址運(yùn)算符）等單目操作符前后不加空格。*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等與后面的括號(hào)間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。if(a>=b&&c>d)?1-1：一行程序以小于80字符為宜，不要寫得過長(zhǎng)。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-1：一般情況下，源程序有效注釋量必須在20％以上說明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-2：說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要說明示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/*************************************************

Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.

Filename:

//文件名

Author:

Version:

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

Description:

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

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

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

Others:

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

FunctionList:

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

1.....

History:

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

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

1.Date:

Author:

Modification:

2....*************************************************/通唐軟件技術(shù)(湖南)有限公司⒉注釋2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/************************************************************

Copyright(C),2011-2012,Tone-timeSoftwareTech.Co.,Ltd.

FileName:test.cpp

Author:

Version:

Date:

Description:

//模塊描述

Version:

//版本信息

FunctionList:

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

1.-------

History:

//歷史修改記錄

<author>

<time>

<version>

<desc>

David

96/10/12

1.0

buildthismoudle

***********************************************************/說明：Description一項(xiàng)描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-4：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(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://被訪問的表（此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫(kù)操作的程序）

TableUpdated:

//被修改的表（此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫(kù)操作的程序）

Input:

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

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

Output:

//對(duì)輸出參數(shù)的說明。

Return:

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

Others:

//其它說明*************************************************/通唐軟件技術(shù)(湖南)有限公司⒉注釋2-5：邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除通唐軟件技術(shù)(湖南)有限公司⒉注釋2-6：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性說明：錯(cuò)誤的注釋不但無益反而有害。通唐軟件技術(shù)(湖南)有限公司⒉注釋規(guī)則2-7：避免在注釋中使用縮寫，特別是非常用縮寫說明：在使用縮寫時(shí)或之前，應(yīng)對(duì)縮寫進(jìn)行必要的說明。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-8：注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語(yǔ)句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開示例：如下例子不符合規(guī)范。例1：/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_data[index].repssn_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;通唐軟件技術(shù)(湖南)有限公司⒉注釋2-9：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方示例：/*activestatistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/通唐軟件技術(shù)(湖南)有限公司⒉注釋2-10：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。/*sccpinterfacewithsccpuserprimitivemessagename*/enum

SCCP_USER_PRIMITIVE{

N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/

N_NOTICE_IND,

/*sccpnotifyusertheNo.7networkcannot*/

/*transmissionthismessage*/

N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/};通唐軟件技術(shù)(湖南)有限公司⒉注釋2-11：全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)注意事項(xiàng)等的說明示例：/*TheErrorCodewhenSCCPtranslate*//*GlobalTitlefailure,asfollows*/

//變量作用、含義/*0－

SUCCESS

1－

GTTableerror*//*2－

GTerror

Others－

nouse

*/

//變量取值范圍/*only

function

SCCPTranslate()in*//*thismodualcanmodifyit,

and

other*//*modulecanvisititthroughcall*//*the

functionGetGTTransErrorCode()*/

//使用方法BYTEg_GTTranErrorCode;

通唐軟件技術(shù)(湖南)有限公司⒉注釋2-12：注釋與所描述內(nèi)容進(jìn)行同樣的縮排說明：可使程序排版整齊，并方便注釋的閱讀與理解。示例：如下例子，排版不整齊，閱讀稍感不方便。voidexample_fun(void){/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo}應(yīng)改為如下布局。voidexample_fun(void){

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo}通唐軟件技術(shù)(湖南)有限公司⒉注釋2-13：將注釋與其上面的代碼用空行隔開示例：如下例子，顯得代碼過于緊湊。/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo應(yīng)如下書寫/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo通唐軟件技術(shù)(湖南)有限公司⒉注釋2-14：對(duì)變量的定義和分支語(yǔ)句（條件分支、循環(huán)語(yǔ)句等）必須編寫注釋說明：這些語(yǔ)句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對(duì)于維護(hù)人員來說，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-15：對(duì)于switch語(yǔ)句下的case語(yǔ)句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語(yǔ)句處理完、下一個(gè)case語(yǔ)句前加上明確的注釋說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語(yǔ)句。示例（注意紅色斜體加粗部分）：caseCMD_FWD:

ProcessFwd();if(...)

{

...

break;

}

else

{

ProcessCFW_B();

//nowjumpintocaseCMD_A

}caseCMD_A:

ProcessA();

break;通唐軟件技術(shù)(湖南)有限公司⒉注釋2-16：避免在一行代碼或表達(dá)式的中間插入注釋說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-17：通過對(duì)函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。通唐軟件技術(shù)(湖南)有限公司⒉注釋2-18：在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。示例：如下注釋意義不大。/*ifreceive_flagisTRUE*/if(receive_flag)而如下的注釋則給出了額外有用的信息。/*ifmtpreceiveamessagefromlinks*/if(receive_flag)通唐軟件技術(shù)(湖南)有限公司⒉注釋2-19：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束說明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。示例：參見如下例子。if(...){

//programcode

while(index<MAX_INDEX)

{

//programcode

}/*endofwhile(index<MAX_INDEX)*///指明該條while語(yǔ)句結(jié)束}/*endof

if(...)*///指明是哪條if語(yǔ)句結(jié)束通唐軟件技術(shù)(湖南)有限公司⒉注釋2-20：注釋格式盡量統(tǒng)一，建議使用“/*……*/”通唐軟件技術(shù)(湖南)有限公司⒉注釋2-21：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語(yǔ)言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)說明：注釋語(yǔ)言不統(tǒng)一，影響程序易讀性和外觀排版，出于對(duì)維護(hù)人員的考慮，建議使用中文。通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-1：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解說明：較短的單詞可通過去掉“元音”形成縮寫；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。示例：如下單詞的縮寫能夠被大家基本認(rèn)可。temp可縮寫為

tmp;flag可縮寫為

flg;statistic可縮寫為

stat;increment可縮寫為

inc;message可縮寫為

msg;通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-2：命名中若使用特殊約定或縮寫，則要有注釋說明說明：應(yīng)該在源文件的開始之處，對(duì)文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說明。通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-3：自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化說明：個(gè)人的命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個(gè)人命名風(fēng)格）。通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-4：對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的說明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫成j），而編譯時(shí)又檢查不出來，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。示例：下面所示的局部變量名的定義方法可以借鑒。intliv_Width其變量名解釋如下：

l

局部變量（Local）

（其它：g

全局變量（Global）...）

i

數(shù)據(jù)類型（Integer）

v

變量（Variable）

（其它：c

常量（Const）...）

Width

變量含義這樣可以防止局部變量與全局變量重名。通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標(biāo)識(shí)如標(biāo)識(shí)成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的示例：

Add_User不允許，add_user、AddUser、m_AddUser允許。通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-6：除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符示例：如下命名，使人產(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);通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-7：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突說明：對(duì)接口部分的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識(shí)等。通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-8：用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等說明：下面是一些在軟件中常用的反義詞組。add/remove

begin/end

create/destroyinsert/delete

first/last

get/releaseincrement/decrement

put/getadd/delete

lock/unlock

open/closemin/max

old/new

start/stopnext/previous

source/target

show/hidesend/receive

source/destinationcut/paste

up/down示例：int

min_sum;int

max_sum;int

add_user(BYTE*user_name);int

delete_user(BYTE*user_name);通唐軟件技術(shù)(湖南)有限公司⒊標(biāo)識(shí)符命名3-9：除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義通唐軟件技術(shù)(湖南)有限公司⒋可讀性4-1：注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)說明：防止閱讀程序時(shí)產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級(jí)與設(shè)計(jì)思想不符而導(dǎo)致程序出錯(cuò)。示例：下列語(yǔ)句中的表達(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)不會(huì)出錯(cuò)，但語(yǔ)句不易理解；a|b<c&d=a|（b<c）

&d，(3)造成了判斷條件出錯(cuò)。通唐軟件技術(shù)(湖南)有限公司⒋可讀性4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替示例：如下的程序可讀性差。if(Trunk[index].trunk_state==0){

Trunk[index].trunk_state=1;

...

//programcode}應(yīng)改為如下形式。#defineTRUNK_IDLE0#defineTRUNK_BUSY1if(Trunk[index].trunk_state==TRUNK_IDLE){

Trunk[index].trunk_state=TRUNK_BUSY;

...

//programcode}通唐軟件技術(shù)(湖南)有限公司⒋可讀性4-3：源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰說明：便于程序閱讀和查找。示例：以下代碼布局不太合理。rect.length=10;char_poi=str;rect.width=5;若按如下形式書寫，可能更清晰一些。rect.length=10;rect.width=5;//矩形的長(zhǎng)與寬關(guān)系較密切，放在一起。char_poi=str;通唐軟件技術(shù)(湖南)有限公司⒋可讀性4-4：不要使用難懂的技巧性很高的語(yǔ)句，除非很有必要時(shí)說明：高技巧語(yǔ)句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于算法。示例：如下表達(dá)式，考慮不周就可能出問題，也較難理解。*stat_poi+++=1;*++stat_poi+=1;應(yīng)分別改為如下:*stat_poi+=1;stat_poi++;

//此二語(yǔ)句功能相當(dāng)于“*stat_poi+++=1;”++stat_poi;*stat_poi+=1;//此二語(yǔ)句功能相當(dāng)于“*++stat_poi+=1;”通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-1：去掉沒必要的公共變量說明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少?zèng)]必要的公共變量以降低模塊間的耦合度。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-2：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系說明：在對(duì)變量聲明的同時(shí)，應(yīng)對(duì)其含義、作用及取值范圍進(jìn)行注釋說明，同時(shí)若有必要還應(yīng)說明與其它變量的關(guān)系。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-3：明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系，如訪問、修改及創(chuàng)建等說明：明確過程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以及代碼維護(hù)等。這種關(guān)系的說明可在注釋或文檔中描述。示例：在源文件中，可按如下注釋形式說明。RELATION

System_Init

Input_Rec

Print_Rec

Stat_ScoreStudent

Create

Modify

Access

AccessScore

Create

Modify

Access

Access,Modify注：RELATION為操作關(guān)系；System_Init、Input_Rec、Print_Rec、Stat_Score為四個(gè)不同的函數(shù)；Student、Score為兩個(gè)全局變量；Create表示創(chuàng)建，Modify表示修改，Access表示訪問。其中，函數(shù)Input_Rec、Stat_Score都可修改變量Score，故此變量將引起函數(shù)間較大的耦合，并可能增加代碼測(cè)試、維護(hù)的難度。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-4：當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生說明：對(duì)公共變量賦值時(shí)，若有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、穩(wěn)定性。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-5：防止局部變量與公共變量同名說明：若使用了較好的命名規(guī)則，那么此問題可自動(dòng)消除。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-6：嚴(yán)禁使用未經(jīng)初始化的變量作為右值說明：特別是在C/C++中引用未經(jīng)賦值的指針，經(jīng)常會(huì)引起系統(tǒng)崩潰。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-7：構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問的公共變量，防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象說明：降低公共變量耦合度。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-8：使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)系密切的變量說明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類型，有利于程序的移植。示例：如下例子（在DOS下BC3.1環(huán)境中），在移植時(shí)可能產(chǎn)生問題。voidmain(){

registerintindex;//寄存器變量

_AX=0x4000;//_AX是BC3.1提供的寄存器“偽變量”

...//programcode}通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-9：結(jié)構(gòu)的功能要單一，是針對(duì)一種事務(wù)的抽象說明：設(shè)計(jì)結(jié)構(gòu)時(shí)應(yīng)力爭(zhēng)使結(jié)構(gòu)代表一種現(xiàn)實(shí)事務(wù)的抽象，而不是同時(shí)代表多種。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。示例：如下結(jié)構(gòu)不太清晰、合理。typedefstructSTUDENT_STRU{

unsignedcharname[8];/*student'sname*/

unsignedcharage;

/*student'sage*/

unsignedcharsex;

/*student'ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedchar

teacher_name[8];/*thestudentteacher'sname*/

unisgnedchar

teacher_sex;

/*histeachersex*/}STUDENT;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)若改為如下，可能更合理些。typedefstructTEACHER_STRU{

unsignedcharname[8];/*teachername*/

unisgnedcharsex;

/*teachersex,asfollows*/

/*0-FEMALE;1-MALE*/}TEACHER;typedefstructSTUDENT_STRU{

unsignedcharname[8];

/*student'sname*/

unsignedcharage;

/*student'sage*/

unsignedcharsex;

/*student'ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedint

teacher_ind;/*histeacherindex*/}STUDENT;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-10：不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)說明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-11：不同結(jié)構(gòu)間的關(guān)系不要過于復(fù)雜說明：若兩個(gè)結(jié)構(gòu)間關(guān)系較復(fù)雜、密切，那么應(yīng)合為一個(gè)結(jié)構(gòu)。示例：如下兩個(gè)結(jié)構(gòu)的構(gòu)造不合理。typedefstructPERSON_ONE_STRU{

unsignedcharname[8];

unsignedcharaddr[40];

unsignedcharsex;

unsignedcharcity[15];}PERSON_ONE;typedefstructPERSON_TWO_STRU{

unsignedcharname[8];

unsignedcharage;

unsignedchartel;}PERSON_TWO;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)由于兩個(gè)結(jié)構(gòu)都是描述同一事物的，那么不如合成一個(gè)結(jié)構(gòu)。typedefstructPERSON_STRU{

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;}PERSON;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-12：結(jié)構(gòu)中元素的個(gè)數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個(gè)數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個(gè)數(shù)說明：增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。示例：假如認(rèn)為如上的_PERSON結(jié)構(gòu)元素過多，那么可如下對(duì)之劃分。typedefstructPERSON_BASE_INFO_STRU{

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;}PERSON_BASE_INFO;typedefstructPERSON_ADDRESS_STRU{

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;}PERSON_ADDRESS;typedefstructPERSON_STRU{

PERSON_BASE_INFOperson_base;

PERSON_ADDRESSperson_addr;}PERSON;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-13：仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象說明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。typedefstructEXAMPLE_STRU{

unsignedintvalid:1;

PERSONperson;

unsignedintset_flg:1;}EXAMPLE;若改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。typedefstructEXAMPLE_STRU{

unsignedintvalid:1;

unsignedintset_flg:1;

PERSONperson;}EXAMPLE;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-14：結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級(jí)，并為某些未來可能的應(yīng)用保留余地（如預(yù)留一些空間等）說明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標(biāo)志之一。如果要想使產(chǎn)品具有較好的前向兼容，那么在產(chǎn)品設(shè)計(jì)之初就應(yīng)為以后版本升級(jí)保留一定余地，并且在產(chǎn)品升級(jí)時(shí)必須考慮前一版本的各種特性。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-15：留心具體語(yǔ)言及編譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細(xì)節(jié)說明：如在C語(yǔ)言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部變量將在“堆?！敝猩?。這些細(xì)節(jié)對(duì)程序質(zhì)量的保證非常重要。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-16：編程時(shí)，要注意數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)換說明：當(dāng)進(jìn)行數(shù)據(jù)類型強(qiáng)制轉(zhuǎn)換時(shí)，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而這些細(xì)節(jié)若考慮不周，就很有可能留下隱患。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-17：對(duì)編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認(rèn)識(shí)示例：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。charchr;unsignedshortintexam;chr=-1;exam=chr;//編譯器不產(chǎn)生告警，此時(shí)exam為0xFFFF。通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-18：盡量減少?zèng)]有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-19：合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-20：對(duì)自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一說明：使用自定義類型，可以彌補(bǔ)編程語(yǔ)言提供類型少、信息量不足的缺點(diǎn)，并能使程序清晰、簡(jiǎn)潔。示例：可參考如下方式聲明自定義數(shù)據(jù)類型。下面的聲明可使數(shù)據(jù)類型的使用簡(jiǎn)潔、明了。typedefunsignedchar

BYTE;typedefunsignedshortWORD;typedefunsignedint

DWORD;下面的聲明可使數(shù)據(jù)類型具有更豐富的含義。typedeffloatDISTANCE;typedeffloatSCORE;通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)5-21：當(dāng)聲明用于分布式環(huán)境或不同CPU間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時(shí)，必須考慮機(jī)器的字節(jié)順序、使用的位域及字節(jié)對(duì)齊等問題說明：如IntelCPU與68360CPU，在處理位域及整數(shù)時(shí)，其在內(nèi)存存放的“順序”正好相反。示例：假如有如下短整數(shù)及結(jié)構(gòu)。unsignedshortintexam;typedefstructEXAM_BIT_STRU{

/*Intel68360*/

unsignedintA1:1;/*bit

0

7

*/

unsignedintA2:1;/*bit

1

6

*/

unsignedintA3:1;/*bit

2

5

*/}EXAM_BIT;如下是IntelCPU生成短整數(shù)及位域的方式。內(nèi)存：

0

1

2

...

（從低到高，以字節(jié)為單位）exam

exam低字節(jié)

exam高字節(jié)內(nèi)存：

0bit

1bit

2bit

...

（字節(jié)的各“位”）EXAM_BIT

A1

A2

A3如下是68360CPU生成短整數(shù)及位域的方式。內(nèi)存：

0

1

2

...

（從低到高，以字節(jié)為單位）exam

exam高字節(jié)

exam低字節(jié)內(nèi)存：

7bit

6bit

5bit

...

（字節(jié)的各“位”）EXAM_BIT

A1

A2

A3通唐軟件技術(shù)(湖南)有限公司⒌變量、結(jié)構(gòu)說明：在對(duì)齊方式下，CPU的運(yùn)行效率要快得多。示例：如下圖，當(dāng)一個(gè)long型數(shù)（如圖中l(wèi)ong1）在內(nèi)存中的位置正好與內(nèi)存的字邊界對(duì)齊時(shí)，CPU存取這個(gè)數(shù)只需訪問一次內(nèi)存，而當(dāng)一個(gè)long型數(shù)（如圖中的long2）在內(nèi)存中的位置跨越了字邊界時(shí)，CPU存取這個(gè)數(shù)就需要多次訪問內(nèi)存，如i960cx訪問這樣的數(shù)需讀內(nèi)存三次（一個(gè)BYTE、一個(gè)SHORT、一個(gè)BYTE，由CPU的微代碼執(zhí)行，對(duì)軟件透明），所有對(duì)齊方式下CPU的運(yùn)行效率明顯快多了。

1

8

16

24

32

----------------------------

|long1|long1|long1|long1|

----------------------------

|

|

|

|long2|

-----------------------------

|long2|long2|long2|

|

-----------------------------

|....通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-1：對(duì)所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-2：明確函數(shù)功能，精確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-3：編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用（如編寫C/C++語(yǔ)言的可重入函數(shù)時(shí)，應(yīng)使用auto即缺省態(tài)局部變量或寄存器變量）說明：編寫C/C++語(yǔ)言的可重入函數(shù)時(shí)，不應(yīng)使用static局部變量，否則必須經(jīng)過特殊處理，才能使函數(shù)具有可重入性。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-4：編寫可重入函數(shù)時(shí)，若使用全局變量，則應(yīng)通過關(guān)中斷、信號(hào)量（即P、V操作）等手段對(duì)其加以保護(hù)說明：若對(duì)所使用的全局變量不加以保護(hù)，則此函數(shù)就不具有可重入性，即當(dāng)多個(gè)進(jìn)程調(diào)用此函數(shù)時(shí)，很有可能使有關(guān)全局變量變?yōu)椴豢芍獱顟B(tài)。示例：假設(shè)Exam是int型全局變量，函數(shù)Squre_Exam返回Exam平方值。那么如下函數(shù)不具有可重入性。unsignedintexample(intpara){

unsignedinttemp;

Exam=para;//（**）

temp=Square_Exam();

returntemp;}此函數(shù)若被多個(gè)進(jìn)程調(diào)用的話，其結(jié)果可能是未知的，因?yàn)楫?dāng)（**）語(yǔ)句剛執(zhí)行完后，另外一個(gè)使用本函數(shù)的進(jìn)程可能正好被激活，那么當(dāng)新激活的進(jìn)程執(zhí)行到此函數(shù)時(shí)，將使Exam賦與另一個(gè)不同的para值，所以當(dāng)控制重新回到“temp=Square_Exam()”后，計(jì)算出的temp很可能不是預(yù)想中的結(jié)果。此函數(shù)應(yīng)如下改進(jìn)。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程unsignedintexample(intpara){

unsignedinttemp;

[申請(qǐng)信號(hào)量操作]

//若申請(qǐng)不到“信號(hào)量”，說明另外的進(jìn)程正處于

Exam=para;

//給Exam賦值并計(jì)算其平方過程中（即正在使用此

temp=Square_Exam();

//信號(hào)），本進(jìn)程必須等待其釋放信號(hào)后，才可繼

[釋放信號(hào)量操作]

//續(xù)執(zhí)行。若申請(qǐng)到信號(hào)，則可繼續(xù)執(zhí)行，但其

//它進(jìn)程必須等待本進(jìn)程釋放信號(hào)量后，才能再使

//用本信號(hào)。

returntemp;}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-5：在同一項(xiàng)目組應(yīng)明確規(guī)定對(duì)接口函數(shù)參數(shù)的合法性檢查應(yīng)由函數(shù)的調(diào)用者負(fù)責(zé)還是由接口函數(shù)本身負(fù)責(zé)，缺省是由函數(shù)調(diào)用者負(fù)責(zé)說明：對(duì)于模塊間接口函數(shù)的參數(shù)的合法性檢查這一問題，往往有兩個(gè)極端現(xiàn)象，即：要么是調(diào)用者和被調(diào)用者對(duì)參數(shù)均不作合法性檢查，結(jié)果就遺漏了合法性檢查這一必要的處理過程，造成問題隱患；要么就是調(diào)用者和被調(diào)用者均對(duì)參數(shù)進(jìn)行合法性檢查，這種情況雖不會(huì)造成問題，但產(chǎn)生了冗余代碼，降低了效率。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-6：防止將函數(shù)的參數(shù)作為工作變量說明：將函數(shù)的參數(shù)作為工作變量，有可能錯(cuò)誤地改變參數(shù)內(nèi)容，所以很危險(xiǎn)。對(duì)必須改變的參數(shù)，最好先用局部變量代之，最后再將該局部變量的內(nèi)容賦給該參數(shù)。示例：下函數(shù)的實(shí)現(xiàn)不太好。voidsum_data(unsignedintnum,int*data,int*sum){

unsignedintcount;

*sum=0;

for(count=0;count<num;count++)

{

*sum

+=data[count];//sum成了工作變量，不太好。

}}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程若改為如下，則更好些。voidsum_data(unsignedintnum,int*data,int*sum){

unsignedintcount;

intsum_temp;

sum_temp=0;

for(count=0;count<num;count++)

{

sum_temp

+=data[count];

}

*sum=sum_temp;}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-7：函數(shù)的規(guī)模盡量限制在200行以內(nèi)說明：不包括注釋和空格行。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-8：一個(gè)函數(shù)僅完成一件功能通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-9：為簡(jiǎn)單功能編寫函數(shù)說明：雖然為僅用一兩行就可完成的功能去編函數(shù)好象沒有必要，但用函數(shù)可使功能明確化，增加程序可讀性，亦可方便維護(hù)、測(cè)試。示例：如下語(yǔ)句的功能不很明顯。value=(a>b)?a:b;改為如下就很清晰了。intmax(inta,intb){

return((a>b)?a:b);}value=max(a,b);或改為如下。#defineMAX(a,b)(((a)>(b))?(a):(b))value=MAX(a,b);通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-10：不要設(shè)計(jì)多用途面面俱到的函數(shù)說明：多功能集于一身的函數(shù)，很可能使函數(shù)的理解、測(cè)試、維護(hù)等變得困難。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-11：函數(shù)的功能應(yīng)該是可以預(yù)測(cè)的，也就是只要輸入數(shù)據(jù)相同就應(yīng)產(chǎn)生同樣的輸出說明：帶有內(nèi)部“存儲(chǔ)器”的函數(shù)的功能可能是不可預(yù)測(cè)的，因?yàn)樗妮敵隹赡苋Q于內(nèi)部存儲(chǔ)器（如某標(biāo)記）的狀態(tài)。這樣的函數(shù)既不易于理解又不利于測(cè)試和維護(hù)。在C/C++語(yǔ)言中，函數(shù)的static局部變量是函數(shù)的內(nèi)部存儲(chǔ)器，有可能使函數(shù)的功能不可預(yù)測(cè)，然而，當(dāng)某函數(shù)的返回值為指針類型時(shí)，則必須是STATIC的局部變量的地址作為返回值，若為AUTO類，則返回為錯(cuò)針。示例：如下函數(shù)，其返回值（即功能）是不可預(yù)測(cè)的。unsignedintinteger_sum(unsignedintbase){

unsignedintindex;

staticunsignedintsum=0;//注意，是static類型的。

//若改為auto類型，則函數(shù)即變?yōu)榭深A(yù)測(cè)。

for(index=1;index<=base;index++)

{

sum+=index;

}

returnsum;}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-12：盡量不要編寫依賴于其他函數(shù)內(nèi)部實(shí)現(xiàn)的函數(shù)說明：此條為函數(shù)獨(dú)立性的基本要求。由于目前大部分高級(jí)語(yǔ)言都是結(jié)構(gòu)化的，所以通過具體語(yǔ)言的語(yǔ)法要求與編譯器功能，基本就可以防止這種情況發(fā)生。但在匯編語(yǔ)言中，由于其靈活性，很可能使函數(shù)出現(xiàn)這種情況。示例：如下是在DOS下TASM的匯編程序例子。過程Print_Msg的實(shí)現(xiàn)依賴于Input_Msg的具體實(shí)現(xiàn)，這種程序是非結(jié)構(gòu)化的，難以維護(hù)、修改。...

//程序代碼procPrint_Msg//過程（函數(shù)）Print_Msg

...

//程序代碼

jmp

LABEL

...

//程序代碼endpprocInput_Msg//過程（函數(shù)）Input_Msg

...

//程序代碼LABEL:

...

//程序代碼endp通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-13：避免設(shè)計(jì)多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉說明：目的減少函數(shù)間接口的復(fù)雜度。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-14：非調(diào)度函數(shù)應(yīng)減少或防止控制參數(shù)，盡量只使用數(shù)據(jù)參數(shù)說明：本建議目的是防止函數(shù)間的控制耦合。調(diào)度函數(shù)是指根據(jù)輸入的消息類型或控制命令，來啟動(dòng)相應(yīng)的功能實(shí)體（即函數(shù)或過程），而本身并不完成具體功能?？刂茀?shù)是指改變函數(shù)功能行為的參數(shù)，即函數(shù)要根據(jù)此參數(shù)來決定具體怎樣工作。非調(diào)度函數(shù)的控制參數(shù)增加了函數(shù)間的控制耦合，很可能使函數(shù)間的耦合度增大，并使函數(shù)的功能不唯一。示例：如下函數(shù)構(gòu)造不太合理。intadd_sub(inta,intb,unsignedcharadd_sub_flg){

if(add_sub_flg==INTEGER_ADD)

{

return(a+b);

}

else

{

return(a

b);

}}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程不如分為如下兩個(gè)函數(shù)清晰。intadd(inta,intb){

return(a+b);}intsub(inta,intb){

return(a

b);}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-15：檢查函數(shù)所有參數(shù)輸入的有效性通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-16：檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等說明：函數(shù)的輸入主要有兩種：一種是參數(shù)輸入；另一種是全局變量、數(shù)據(jù)文件的輸入，即非參數(shù)輸入。函數(shù)在使用輸入之前，應(yīng)進(jìn)行必要的檢查。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-17：函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-18：使用動(dòng)賓詞組為執(zhí)行某操作的函數(shù)命名。如果是OOP方法，可以只有動(dòng)詞（名詞是對(duì)象本身）示例：參照如下方式命名函數(shù)。voidprint_record(unsignedintrec_ind);int

input_record(void);unsignedcharget_current_color(void);通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-19：避免使用無意義或含義不清的動(dòng)詞為函數(shù)命名說明：避免用含義不清的動(dòng)詞如process、handle等為函數(shù)命名，因?yàn)檫@些動(dòng)詞并沒有說明要具體做什么。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-20：函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯(cuò)誤情況說明：函數(shù)的每種出錯(cuò)返回值的意義要清晰、明了、準(zhǔn)確，防止使用者誤用、理解錯(cuò)誤或忽視錯(cuò)誤返回碼。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-21：除非必要，最好不要把與函數(shù)返回值類型不同的變量，以編譯系統(tǒng)默認(rèn)的轉(zhuǎn)換方式或強(qiáng)制的轉(zhuǎn)換方式作為返回值返回通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-22：讓函數(shù)在調(diào)用點(diǎn)顯得易懂、容易理解通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-23：在調(diào)用函數(shù)填寫參數(shù)時(shí)，應(yīng)盡量減少?zèng)]有必要的默認(rèn)數(shù)據(jù)類型轉(zhuǎn)換或強(qiáng)制數(shù)據(jù)類型轉(zhuǎn)換說明：因?yàn)閿?shù)據(jù)類型轉(zhuǎn)換或多或少存在危險(xiǎn)。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-24：避免函數(shù)中不必要語(yǔ)句，防止程序中的垃圾代碼說明：程序中的垃圾代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測(cè)試、維護(hù)等造成不必要的麻煩。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-25：防止把沒有關(guān)聯(lián)的語(yǔ)句放到一個(gè)函數(shù)中說明：防止函數(shù)或過程內(nèi)出現(xiàn)隨機(jī)內(nèi)聚。隨機(jī)內(nèi)聚是指將沒有關(guān)聯(lián)或關(guān)聯(lián)很弱的語(yǔ)句放到同一個(gè)函數(shù)或過程中。隨機(jī)內(nèi)聚給函數(shù)或過程的維護(hù)、測(cè)試及以后的升級(jí)等造成了不便，同時(shí)也使函數(shù)或過程的功能不明確。使用隨機(jī)內(nèi)聚函數(shù)，常常容易出現(xiàn)在一種應(yīng)用場(chǎng)合需要改進(jìn)此函數(shù)，而另一種應(yīng)用場(chǎng)合又不允許這種改進(jìn)，從而陷入困境。在編程時(shí)，經(jīng)常遇到在不同函數(shù)中使用相同的代碼，許多開發(fā)人員都愿把這些代碼提出來，并構(gòu)成一個(gè)新函數(shù)。若這些代碼關(guān)聯(lián)較大并且是完成一個(gè)功能的，那么這種構(gòu)造是合理的，否則這種構(gòu)造將產(chǎn)生隨機(jī)內(nèi)聚的函數(shù)。示例：如下函數(shù)就是一種隨機(jī)內(nèi)聚。voidInit_Var(void){

Rect.length=0;

Rect.width=0;/*初始化矩形的長(zhǎng)與寬*/

Point.x=10;

Point.y=10;

/*初始化“點(diǎn)”的坐標(biāo)*/}矩形的長(zhǎng)、寬與點(diǎn)的坐標(biāo)基本沒有任何關(guān)系，故以上函數(shù)是隨機(jī)內(nèi)聚。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程應(yīng)如下分為兩個(gè)函數(shù)：voidInit_Rect(void){

Rect.length=0;

Rect.width=0;/*初始化矩形的長(zhǎng)與寬*/}voidInit_Point(void){

Point.x=10;

Point.y=10;

/*初始化“點(diǎn)”的坐標(biāo)*/}通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-26：如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題說明：若此段代碼各語(yǔ)句之間有實(shí)質(zhì)性關(guān)聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構(gòu)造成一個(gè)新的函數(shù)。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-27：功能不明確較小的函數(shù)，特別是僅有一個(gè)上級(jí)函數(shù)調(diào)用它時(shí)，應(yīng)考慮把它合并到上級(jí)函數(shù)中，而不必單獨(dú)存在說明：模塊中函數(shù)劃分的過多，一般會(huì)使函數(shù)間的接口變得復(fù)雜。所以過小的函數(shù)，特別是扇入很低的或功能不明確的函數(shù)，不值得單獨(dú)存在。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-28：設(shè)計(jì)高扇入、合理扇出（小于7）的函數(shù)說明：扇出是指一個(gè)函數(shù)直接調(diào)用（控制）其它函數(shù)的數(shù)目，而扇入是指有多少上級(jí)函數(shù)調(diào)用它。扇出過大，表明函數(shù)過分復(fù)雜，需要控制和協(xié)調(diào)過多的下級(jí)函數(shù)；而扇出過小，如總是1，表明函數(shù)的調(diào)用層次可能過多，這樣不利程序閱讀和函數(shù)結(jié)構(gòu)的分析，并且程序運(yùn)行時(shí)會(huì)對(duì)系統(tǒng)資源如堆?？臻g等造成壓力。函數(shù)較合理的扇出（調(diào)度函數(shù)除外）通常是3-5。扇出太大，一般是由于缺乏中間層次，可適當(dāng)增加中間層次的函數(shù)。扇出太小，可把下級(jí)函數(shù)進(jìn)一步分解多個(gè)函數(shù)，或合并到上級(jí)函數(shù)中。當(dāng)然分解或合并函數(shù)時(shí)，不能改變要實(shí)現(xiàn)的功能，也不能違背函數(shù)間的獨(dú)立性。扇入越大，表明使用此函數(shù)的上級(jí)函數(shù)越多，這樣的函數(shù)使用效率高，但不能違背函數(shù)間的獨(dú)立性而單純地追求高扇入。公共模塊中的函數(shù)及底層函數(shù)應(yīng)該有較高的扇入。較良好的軟件結(jié)構(gòu)通常是頂層函數(shù)的扇出較高，中層函數(shù)的扇出較少，而底層函數(shù)則扇入到公共模塊中。通唐軟件技術(shù)(湖南)有限公司⒍函數(shù)、過程6-29：減少函數(shù)本身或函數(shù)間的遞歸調(diào)用說明：遞歸調(diào)用特別是函數(shù)間的遞歸