華為軟件編碼規(guī)范

目錄

1排版6

2注釋11

3標(biāo)識(shí)符命名18

4可讀性20

5變量、構(gòu)造22

6函數(shù)、過(guò)程28

7可測(cè)性36

8程序效率40

9質(zhì)量保證44

10代碼編輯、編譯、審查50

11代碼測(cè)試、維護(hù)52

12宏53

1排版

'1-1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個(gè)。

闡明：對(duì)于由開(kāi)發(fā)工具自動(dòng)生成日勺代碼可以有不一致。

11-2：相對(duì)獨(dú)立的程序塊之間、變量闡明之后必須加空行。

示例：如下例子不符合規(guī)范。

if(!valid_ni(ni))

(

...//programcode

)

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

應(yīng)如下書寫

if(!valid_ni(ni))

(

...//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

'1-3：較長(zhǎng)的語(yǔ)句(>80字符》要提成多行書寫，長(zhǎng)體現(xiàn)式要在低優(yōu)先級(jí)操作符處劃分新行,

操作符放在新行之首，劃分出的新行要進(jìn)行合適的縮進(jìn)，使排版整潔，語(yǔ)句可讀。

示例:

perm_count_msg.head.len=NQ7_TO_STAT_PERM_COUNT_LEN

+STAT_SIZE_PER_FRAM*sizeof(_UL);

act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied

=statpoi[index].occupied;

act__task_table(tas.<nol.duration_true_or_false

=SYS_ycL_i>i;cp_5iLetLit>Lic_?LciLe(Lem);

report_or_not_flag=((taskno<MAX_ACT_TASK_NUMBER)

&&(n7stat_stat_item_valid(stat_item))

&&(acttasktable[taskno].resultdata!=0));

*1-4：循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的體現(xiàn)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)體現(xiàn)式要在低

優(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

}

*1-5：若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行合適的劃分。

示例：

n7stat_str_compare((BYTE*)&stat_object,

(BYTE*)&(act_task_table[taskno].stat_object),

sizeof(STATOBJECT));

n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER

+index,stat_object);

'1-6：不容許把多種短語(yǔ)句寫在一行中，即一行只寫一條語(yǔ)句。

示例：如下例子不符合規(guī)范。

rect.length=0;rect.width=0;

應(yīng)如下書寫

rect.length=0;

rect.width=0;

'1-7：if>for>do、while、case、switch、default等語(yǔ)句自占一行，且if、for^

d。、while等語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào)｛｝。

示例：如下例子不符合規(guī)范。

if(pUserCR==NULL)return;

應(yīng)如卜書寫：

if(pUserCR==NULL)

(

return;

｝

,1-8:對(duì)齊只使用空格鍵，不使用TAB鍵。

闡明：以免用不一樣的編輯器閱讀程序時(shí)，因TAB鍵所設(shè)置的空格數(shù)目不一樣而導(dǎo)致程序

布局不整潔，不要使用BC作為編輯器合版本，由于BC會(huì)自動(dòng)將8個(gè)空格變?yōu)橐环NTAB

鍵，因此使用BC合入的版本大多會(huì)將縮進(jìn)變亂。

>1-9：函數(shù)或過(guò)程的開(kāi)始、構(gòu)造的定義及循環(huán)、判斷等語(yǔ)句中的J代碼都要采用縮進(jìn)風(fēng)格，case

語(yǔ)句下的狀況處理語(yǔ)句也要遵從語(yǔ)句縮進(jìn)規(guī)定。

*1-10:程序塊的分界符(如C/C++語(yǔ)言的大括號(hào)'{‘和'}')應(yīng)各獨(dú)占一行并且位于同一

列，同步與引用它們的語(yǔ)句左對(duì)齊。在函數(shù)體的開(kāi)始、類的定義、構(gòu)造的定義、枚舉的I定義以

及if、for、do、while、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。

示例：如下例子不符合規(guī)范。

for(...){

...//programcode

}

if(...)

(

...//programcode

)

voidexample_fun(void)

(

...//programcode

)

應(yīng)如下書寫。

for(...)

...//programcode

if(...)

...//programcode

)

voidexample_fun(void)

(

...//programcode

)

11-11：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或

者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，假如是關(guān)系親密的立即操作符(如一＞),后不應(yīng)加空

格。

闡明：采用這種松散方式編寫代碼的目的是使代碼愈加清晰。

由于留空格所產(chǎn)生日勺清晰性是相對(duì)的J,因此，在已經(jīng)豐常清晰的語(yǔ)句中沒(méi)有必要再留空格,

假如語(yǔ)句已足夠清晰則括號(hào)內(nèi)側(cè)(即左括號(hào)背面和右括號(hào)前面)不需要加空格，多重括號(hào)間

不必加空格，由于在C/C++語(yǔ)言中括號(hào)已經(jīng)是最清晰II勺標(biāo)志了。

在長(zhǎng)語(yǔ)句中，假如需要加的空格非常多，那么應(yīng)當(dāng)保持整體清晰，而在局部不加空格。給

操作符留空格時(shí)不要持續(xù)留兩個(gè)以上空格。

示例：

(1)逗號(hào)、分號(hào)只在背面加空格。

inta,b,c;

(2)比較操作符,賦值操作符“="、"+=”，算術(shù)操作符“+“、叫”，邏輯操作符“&&”、

”&”，位域操作符…等雙目操作符H勺前后加空格。

if(current_time>=MAX_TIME_VALUE)

a=b+c;

a*=2;

a=bA2;

(3)“！“、”(地址運(yùn)算符)等單目操作符前后不加空格。

*P='a';//內(nèi)容操作”*”與內(nèi)容之間

flag=JisEmpty;//非操作“！”與內(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)

V21-1：一行程序以不大于80字符為宜,不要寫得過(guò)長(zhǎng)。

2注釋

>2-1：一般狀況下，源程序有效注釋量必須在20%以上。

闡明：注釋的原則是有助于對(duì)程序H勺閱讀理解，在該加日勺地方都加了，注釋不適宜太多也

不能太少，注釋語(yǔ)言必須精確、易懂、簡(jiǎn)潔。

*2-2：闡明性文獻(xiàn)(如頭文獻(xiàn).h文獻(xiàn)、.inc文獻(xiàn)、.def文獻(xiàn)、編譯闡明文獻(xiàn).cfg等)頭部應(yīng)

進(jìn)行注釋，注釋必須列出：版權(quán)闡明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其他文獻(xiàn)的

關(guān)系、修改日志等，頭文獻(xiàn)的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要闡明。

示例：下面這段頭文獻(xiàn)的頭注釋比較原則，當(dāng)然，并不局限于此格式，但上述信息提議要

包括在內(nèi)。

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

Filename://文獻(xiàn)名

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

Description://用于詳細(xì)闡明此程序文獻(xiàn)完畢的重要功能，與其他模塊

//或函數(shù)II勺接口，輸出值、取直范圍、含義及參數(shù)間【內(nèi)控

〃制、次序、獨(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.

'2-3：源文獻(xiàn)頭部應(yīng)進(jìn)行注釋，列出：版權(quán)闡明、版本號(hào)、生成日期、作者、模塊目的/功能、

重要函數(shù)及其功能、修改日志等。

示例：下面這段源文獻(xiàn)II勺頭注釋比較原則，當(dāng)然，并不局限于此格式，但上述信息提議要

包括在內(nèi)。

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

FileName:test.cpp

Author:Version:Date:

Description://模塊描述

Version://版本信息

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

1.------------

History://歷史修改記錄

<author><time><version><desc>

David96/10/121.0buildthismoudle

闡明：Description一項(xiàng)描述本文獻(xiàn)的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文獻(xiàn)與

其他文獻(xiàn)關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改

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

'2-4：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用

關(guān)系（函數(shù)、表）等。

示例：下面這段函數(shù)的注釋比較原則，當(dāng)然，并不局限于此格式，但上述信息提議要包括

在內(nèi)。

Function://函數(shù)名稱

Description://函數(shù)功能、性能等日勺描述

Calls://被本函數(shù)調(diào)用的函數(shù)清單

CalledBy://調(diào)用本函數(shù)的函數(shù)清單

TableAccessed://被訪問(wèn)的I表（此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫(kù)操作口勺程序）

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

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

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

Output://對(duì)輸出參數(shù)H勺闡明。

Return://函數(shù)返回值H勺闡明

Others://其他闡明

*2-5：邊寫代碼邊注釋，修改代碼同步修改對(duì)應(yīng)的注釋，以保證注釋與代碼的一致性。不再有

用的）注釋要?jiǎng)h除。

'2-6：注釋的內(nèi)容要清晰、明了，含義精確，防止注釋二義性。

闡明：錯(cuò)誤的注釋不僅無(wú)益反而有害。

規(guī)則2-7：防止在注釋中使用縮寫，尤其是非常用縮寫。

闡明：在使用縮寫時(shí)或之前，應(yīng)對(duì)縮寫進(jìn)行必要的闡明。

'2-8：注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語(yǔ)句的注釋）

相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開(kāi)。

示例：如下例子不符合規(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;

'2-9：對(duì)于所有有物理含義的I變量、常量，假如其命名不是充足自注釋的，在申明時(shí)都必須加

以注釋，闡明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。

示例：

/*activestatistictasknumber

#defineMAXACTTASKNUMBER1000

#defineMAXACTTASKNUMBER1000/*activestatistictasknumber*/

-2-10:數(shù)據(jù)構(gòu)造申明(包括數(shù)組、構(gòu)造、類、枚舉等)，假如其命名不是充足自注釋的，必須

加以注釋。對(duì)數(shù)據(jù)構(gòu)造的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)構(gòu)造中的每個(gè)域的注

釋放在此域的右方。

示例：可按如下形式闡明枚舉/數(shù)據(jù)/聯(lián)合構(gòu)造。

/*seepinterfacewithseepuserprimitivemessagename*/

enumSCCP_USER_PRIMITIVE

(

N_UNITDATA_INDZ/*seepnotifyseepuserunitdatacome*/

N_NOTICE_IND,/*seepnotifyusertheNo.7networkcannet*/

/*transmissionthismessage*/

N_UNITDATA_REQ,/*seepuser1sunitdatatransmissionrequest*/

｝；

12-11：全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及

存取時(shí)注意事項(xiàng)等的闡明。

示例：

/*TheErrorCodewhenSCCPtranslate*/

/*GlobalTitlefailure,asfollows*///變量作用、含義

/*0—SUCCESS1—GTTableerror*/

/*2—GTerrorOthers—nouse*///變量取值范圍

/*onlyfunctionSCCPTranslate()in*/

/*thismodualcanmodifyit,andother*/

/*modulecanvisititthroughcall*/

/*thefunctionGetGTTransErrorCode()*///使用措施

BYTEgGTTranErrorCode;

'2-12：注釋與所描述內(nèi)容進(jìn)行同樣的縮排。

闡明：可使程序排版整潔，并以便注釋的閱讀與理解。

示例：如下例子，排版不整潔，閱讀稍感不以便。

voidexample_fun(void)

(

/*codeonecomments+/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

應(yīng)改為如下布局。

voidexample_fun(void)

I

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

12-13：將注釋與其上面的代碼用空行隔開(kāi)。

示例：如下例子，顯得代碼過(guò)于緊湊。

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

應(yīng)如下書寫

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

*2-14：對(duì)變量的定義和分支語(yǔ)句（條件分支、循環(huán)語(yǔ)句等）必須編寫注釋。

闡明：這些語(yǔ)句往往是程序?qū)崿F(xiàn)某一特定功能H勺關(guān)鍵，對(duì)于維護(hù)人員來(lái)說(shuō)，良好的注釋協(xié)

助更好日勺理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。

12-15：對(duì)于switch語(yǔ)句下的case語(yǔ)句，假如由于特殊狀況需要處理完一種case后進(jìn)入下一

種case處理，必須在該case語(yǔ)句處理完、下一種case語(yǔ)句前加上明確的注釋。

闡明：這樣比較清晰程序編寫者的意圖，有效防止無(wú)端遺漏break語(yǔ)句。

示例（注意斜體加粗部分）：

caseCMD_UP:

ProcessUp（）;

break;

caseCMD_DOWN:

ProcessDown(j;

break;

caseCMD_FWD:

ProcessFwd();

if

break;

}

else

(

ProcessCFW_B();//nowjumpintocaseCMD_A

}

caseCMD_A:

ProcessA();

break;

caseCMD_B:

ProcessB();

break;

caseCMD_C:

ProcessC();

break;

caseCMD_D:

ProcessD();

break;

3：防止在一行代碼或體現(xiàn)式的中間插入注釋。

闡明：除非必要，不應(yīng)在代碼或體現(xiàn)中間插入注釋，否則輕易使代碼可理解性變差。

%22：通過(guò)對(duì)函數(shù)或過(guò)程、變量、構(gòu)造等對(duì)的的命名以及合理地組織代碼的構(gòu)造,使代碼成為

自注釋的。

闡明：清晰精確的函數(shù)、變量等日勺命名，可增長(zhǎng)代碼可讀性，并減少不必要時(shí)注釋。

力2?3：在代碼的功能、意圖層次上進(jìn)行注釋,提供有用、額外的信息。

闡明：注釋日勺目的是解釋代碼日勺FI的I、功能和采用的)措施，提供代碼以外日勺信息，協(xié)助讀

者理解代碼，防止沒(méi)必要的反夏注釋信息。

示例：如下注釋意義不大。

/*ifrcccivc_flagicTRUE*/

if(receive_flag)

而如下的注釋則給出了額外有用的信息。

/*ifmtpreceiveamessagefromlinks*/

if(receive_flag)

必24：在程序塊的結(jié)束行右方加注釋標(biāo)識(shí),以表明某程序塊的結(jié)束。

闡明：現(xiàn)代碼段較長(zhǎng)，尤其是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。

示例：參見(jiàn)如下例子。

if(...)

(

//programcode

while(index<MAXINDEX)

//programcode

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

束

}/*endofif(...)*///指明是哪條if語(yǔ)句結(jié)束

%25注釋格式盡量統(tǒng)一,提議使用V*……*/〃。

力2?6：注釋應(yīng)考慮程序易讀及外觀排版的原因,使用的語(yǔ)言若是中、英兼有的,提議多使用中

文，除非能用非常流利精確的英文體現(xiàn)。

闡明：注釋語(yǔ)言不統(tǒng)一，影響程序易讀性和外觀排版，出于對(duì)維護(hù)人員的考慮，提議使用

中文。

3標(biāo)識(shí)符命名

'3-1：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同步使用完整的單詞或大家基本可以理解的

縮寫，防止使人產(chǎn)生誤解。

闡明：較短的單詞可通過(guò)去掉“元音”形成縮寫：較長(zhǎng)日勺單詞可取單詞的J頭幾種字母形成

縮寫；某些單詞有大家公認(rèn)的縮寫。

示例：如下單詞的縮寫可以被大家基本承認(rèn)。

temp可縮寫為tmp;

flag可縮寫為fig;

statistic可縮寫為stat;

increment可縮寫為inc;

message可縮寫為msg;

'3-2：命名中若使用特殊約定或縮寫，則要有注釋闡明。

闡明：應(yīng)當(dāng)在源文獻(xiàn)的開(kāi)始之處，對(duì)文獻(xiàn)中所使用口勺縮寫或約定，尤其是特殊H勺縮寫，進(jìn)

行必要日勺注釋闡明。

）3-3：自己特有的命名風(fēng)格，要自始至終保持一致，不可來(lái)回變化。

闡明：個(gè)人依J命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組時(shí)命名規(guī)則的前提下，才可使用。（即

命名規(guī)則中沒(méi)有規(guī)定到的J地方才可有個(gè)人命名風(fēng)格）。

*3-4：對(duì)于變量命名，嚴(yán)禁取單個(gè)字符（如i、j、k...），提議除了要有詳細(xì)含義外，還能

表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是容許的J。

闡明：變量，尤其是局部變量，假如用單個(gè)字符表達(dá)，很輕易敲錯(cuò)（如i寫成j）,而編

譯時(shí)又檢查不出來(lái)，有也許為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。

示例：下面所示的局部變量名的定義措施可以借鑒。

intliv_width

其變量名解釋如下：

1局部變量(Local)(其他：g全局變量(Global)...)

i數(shù)據(jù)類型(Interger)

v變量(Variable)(其他：c常量(Const)...)

Width變量含義

這樣可以防止局部變量與全局變量重名。

'3-5:命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，例如采用UN工X的

全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊

標(biāo)識(shí)如標(biāo)識(shí)組員變量或全局變量的m_和g_,其后加上大小寫混排的方式是容許的。

示例：Add_User不容許，add_user、AddUser、m_AddUser容許。

%3?1：除非必要,不要用數(shù)字或較奇怪的字符來(lái)定義標(biāo)識(shí)符。

示例：如下命名，使人產(chǎn)生疑惑。

#define_EXAMPLE_O_TEST_

#define_EXAMPLE_1_TEST_

voidset_sls00(BYTEsis);

應(yīng)改為故意義日勺單詞命名

#define_EXAMPLE_UNIT_TEST_

#define_EXAMPLE_ASSERT_TEST_

voidset_udt_msg_sls(BYTEsis);

%32在同一軟件產(chǎn)品內(nèi),應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符（變量、構(gòu)造、函數(shù)及常量）的命名,防

止編譯、鏈接時(shí)產(chǎn)生沖突。

闡明：對(duì)接口部分的標(biāo)識(shí)符應(yīng)當(dāng)有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常

量之前加上“模塊”標(biāo)識(shí)等。

%3?3：用對(duì)的的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等。

闡明：下面是某些在軟件中常用的反義詞組。

add/removebegin/endcreate/destroy

insert/deletefirst/lastget/release

increment/decrementput/get

add/deletelock/unlockopen/close

min/maxold/newstart/stop

next/previoussource/targetshow/hide

send/receivesource/destination

cut/pasteup/down

示例：

intmin_sum;

intmax_sum;

intadd_user(BYTE*user_name);

intdelete_user(BYTE*user_name);

V23-4：除了編譯開(kāi)關(guān)/頭文獻(xiàn)等特殊應(yīng)用,應(yīng)防止使用fXAMPLE[￡ST_之類如下劃線開(kāi)始和

結(jié)尾的定義。

4可讀性

'4-1：注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確體現(xiàn)式的操作次序，防止使用默認(rèn)優(yōu)先級(jí)。

闡明：防止閱讀程序時(shí)產(chǎn)生誤解?，防止因默認(rèn)日勺優(yōu)先級(jí)與設(shè)計(jì)思想不符而導(dǎo)致程序出錯(cuò)。

示例：下列語(yǔ)句中的體現(xiàn)式

word=(high<<8)|low(1)

if((a|b)&&la&c))(2)

if((aIb)<(c&d))(3)

假如書寫為

high<<8|low

a|b&&a&c

a|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=aI(b<c)&d,(3)導(dǎo)致了判斷條件出錯(cuò)。

'4-2：防止使用不易理解的數(shù)字，用故意義的標(biāo)識(shí)來(lái)替代。波及物理狀態(tài)或者具有物理意義的

常量，不應(yīng)直接使用數(shù)字，必須用故意義的枚舉或宏來(lái)替代。

示例：如下的程序可讀性差。

if(Trunk[index],trunk_state==0)

(

Trunk[index].trunk_state=1;

...//programcode

應(yīng)改為如下形式。

#defineTRUNK_IDLE0

#defineTRUNK_BUSY1

if(Trunk[index].trunk_state==TRUNK_IDLE)

(

Trunk[index].trunk_state=TRUNK_BUSY;

...//programcode

)

妨4?h源程序中關(guān)系較為緊密的代碼應(yīng)盡量相鄰.

闡明：便于程序閱讀和查找。

示例：如下代碼布局不太合理。

rect.length=10;

char_poi=str;

rect.width=5;

若按如下形式書寫，也許更清晰某些。

rect.length=10;

rect.width=5;//矩形I向長(zhǎng)與寬關(guān)系較親密，放在一起。

char_poi=str;

%42不要使用難懂的技巧性很高的語(yǔ)句,除非很有必要時(shí)。

闡明：高技巧語(yǔ)句不等于高效率日勺程序，實(shí)際上程序日勺效率關(guān)鍵在于算法。

示例：如下體現(xiàn)式，考慮不周就也許出問(wèn)題，也較難理解。

*stat_poi+++=1;

*++stat_poi+=1;

應(yīng)分別改為如下。

*stat_poi+=1;

stat_poi++;//此二語(yǔ)句功能相稱于"*stat_poi+++=1;

++stat_poi;

*statpoi+=1;//此二語(yǔ)句功能相稱于"*++statpoi+=1;

5變量、構(gòu)造

)5-1：去掉沒(méi)必要的公共變量。

闡明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少?zèng)]必要的J公共變量以減少模塊間

日勺耦合度。

*5-2：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。

闡明：在對(duì)變量申明的同步，應(yīng)對(duì)其含義、作用及取值范圍進(jìn)行注釋闡明，同步若有必要

還應(yīng)闡明與其他變量的關(guān)系。

-5-3：明確公共變量與操作此公共變量的函數(shù)或過(guò)程的關(guān)系，如訪問(wèn)、修改及創(chuàng)立等。

闡明：明確過(guò)程操作變量的關(guān)系后，將有助于程序的深入優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以及

代碼維護(hù)等。這種關(guān)系的闡明可在注釋或文檔中描述。

示例：在源文獻(xiàn)中，可按如下注釋形式闡明。

RELATIONSystem_InitInput_RecPrint_RecStat_Score

StudentCreateModifyAccessAccess

ScoreCreateModifyAccessAccess,Modify

注：RELATION為操作關(guān)系；System_1nit、Input_Rec>Print_Rec、Stat_Score

為四個(gè)不?樣口勺函數(shù)；StudentsScore為兩個(gè)全局變量；Create表達(dá)創(chuàng)立，Modify

表達(dá)修改，Access表達(dá)訪問(wèn)。

其中，函數(shù)工nputRec、StaJScore都可修變化量Score,故此變量將引起函數(shù)間較

大的耦合，并也許增長(zhǎng)代碼測(cè)試、維護(hù)日勺難度。

*5-4：當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的I值或越界等現(xiàn)象發(fā)生。

闡明：對(duì)公共變量賦值時(shí)，若有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、穩(wěn)定性。

*5-5:防止局部變量與公共變量同名。

闡明：若使用了很好的命名規(guī)則，那么此問(wèn)題可自動(dòng)消除。

'5-6：嚴(yán)禁使用未經(jīng)初始化的變量作為右值。

闡明：尤其是在C/C十十中引用木經(jīng)賦值口勺指針，常常會(huì)引起系統(tǒng)瓦解。

構(gòu)造僅有一種模塊或函數(shù)可以修改、創(chuàng)立,而其他有關(guān)模塊或函數(shù)只訪問(wèn)的公共變量,

防止多種不一樣模塊或函數(shù)都可以修改、創(chuàng)立同一公共變量的現(xiàn)象。

闡明：減少公共變量耦合度。

必52使用嚴(yán)格形式定義附、可移植的數(shù)據(jù)類型,盡量不要使用與詳細(xì)硬件或軟件環(huán)境關(guān)系親

密的變量。

闡明：使用原則的數(shù)據(jù)類型，有助于程序的移植。

示例：如下例子（在DOS下BC3.1環(huán)境中），在移植時(shí)也許產(chǎn)生問(wèn)題。

voidmain（）

（

registerintindex;//寄存器變量

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

...//programcode

）

力5?3：構(gòu)造的功能要單一,是針對(duì)一種事務(wù)的抽象。

闡明：設(shè)計(jì)構(gòu)造時(shí)應(yīng)力爭(zhēng)使構(gòu)造代表一種現(xiàn)實(shí)事務(wù)的抽象，而不是同步代表多種。構(gòu)造中

的各元素應(yīng)代表同一事務(wù)的不一樣側(cè)面，而不應(yīng)把描述沒(méi)有關(guān)系或關(guān)系很弱口勺不一樣事務(wù)

的元素放到同一構(gòu)造中。

示例：如下構(gòu)造不太清晰、合理。

typedefstructSTUDENT_STRU

(

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

unsignedcharage;/*student'sage*/

unsignedcharsex;/*student'ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedchar

teacher_name[8];/*thestudentteacher1sname*/

unisgnedchar

teacher_sex;/*histeachersex*/

}STUDENT;

若改為如下，也許更合理些。

typedefstructTEACHER_STRU

(

unsignedcharname[8];/*teachername*/

unisgnedcharsex;/*teachersex,asfollows*/

/*0-FEMALE;1-MALE*/

}TEACHER;

typedefstructSTUDENT_STRU

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

unsignedcharage;/*student1sage*/

unsignedcharsex;/*student1ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedintteacher_ind;/*histeacherindex*

}STUDENT;

V25-4：不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)構(gòu)造。

闡明：面面俱到、靈活?的數(shù)據(jù)構(gòu)造反而輕易引起誤解和操作困難。

%5-5：不一樣構(gòu)造間的關(guān)系不要過(guò)于復(fù)雜。

闡明：若兩個(gè)構(gòu)造間關(guān)系較復(fù)雜、親密，那么應(yīng)合為一種構(gòu)造。

示例：如下兩個(gè)構(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;

由于兩個(gè)構(gòu)造都是描述同一事物日勺，那么不如合成一種構(gòu)造。

typedefstructPERSON_STRU

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSON;

以56構(gòu)造中元素的個(gè)數(shù)應(yīng)適中。若構(gòu)造中元素個(gè)數(shù)過(guò)多可考慮根據(jù)某種原則把元素構(gòu)成不一

樣的子構(gòu)造,以減少原構(gòu)造中元素的個(gè)數(shù)。

闡明：增長(zhǎng)構(gòu)造的可理解性、可操作性和可維護(hù)性。

示例：假如認(rèn)為如上的.PERSON構(gòu)造元素過(guò)多，那么可如下對(duì)之劃分。

typedefstructPERSON_BASE_INFO_STRU

(

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

}PERSON_BASE_INFO;

typedefstructPERSON_ADDRESS_STRU

(

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSONADDRESS；

typedefstructPERSON_STRU

(

PERSON_BASE_INFOperson_base;

PERSON_ADDRESSperson_addr;

}PERSON;

i%5-7：仔細(xì)設(shè)計(jì)構(gòu)造中元素的布局與排列次序,使構(gòu)造輕易理解、節(jié)省占用空間,并減少引起

誤用現(xiàn)象。

闡明：合理排列構(gòu)造中元素次序，可節(jié)省空間并增長(zhǎng)可理解性。

示例：如下構(gòu)造中日勺位域排列，將占較大空間，可讀性也稍差。

typedefstructEXAMPLE_STRU

(

unsignedintvalid:1;

PERSONperson;

unsignedintset_f1g:1;

}EXAMPLE;

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

typedefstructEXAMPLE_STRU

(

unsignedintvalid:1;

unsignedintset_f1g:1;

PERSONperson;

}EXAMPLE;

力5?8：構(gòu)造的設(shè)計(jì)要盡量考慮向前兼容和后來(lái)的版本升級(jí),并為某些未來(lái)也許的應(yīng)用保留余地

（如預(yù)留某些空間等）。

闡明：軟件向前兼容的特性，是軟件產(chǎn)品與否成功的重要標(biāo)志之一。假如要想使產(chǎn)品具有

很好的前向兼容，那么在產(chǎn)品設(shè)計(jì)之初就應(yīng)為后來(lái)版本升級(jí)保留一定余地，并且在產(chǎn)品升

級(jí)時(shí)必須考慮前一版本的多種特性。

*5-9：留心詳細(xì)語(yǔ)言及編譯器處理不一樣數(shù)據(jù)類型的原則及有關(guān)細(xì)節(jié)。

闡明：如在C語(yǔ)言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部

變量將在“堆?！敝猩?。這些細(xì)節(jié)對(duì)程序質(zhì)量的保證非常重要。

V25-10：編程時(shí),要注意數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)換。

闡明：當(dāng)進(jìn)行數(shù)據(jù)類型強(qiáng)制4專換時(shí)，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等均有也許發(fā)生變化，

而這些細(xì)節(jié)若考慮不周，就很有也許留卜.隱患。

1

/25-11：對(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為OxFFFF。

/5?12：盡量減少?zèng)]有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)賣。

1/25-13：合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型,防止數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換。

V25-14：對(duì)自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名,使它成為自描述性的,以提高代碼可讀性。注意其

命名方式在同一產(chǎn)品中的統(tǒng)一。

闡明：使用自定義類型，可以彌補(bǔ)編程語(yǔ)言提供類型少、信息量局限性的缺陷，并能使程

序清晰、簡(jiǎn)潔。

示例：可參照如下方式申明自定義數(shù)據(jù)類型。

卜面的申明可使數(shù)據(jù)類型的使用簡(jiǎn)潔、明了。

typedefunsignedcharBYTE;

typedefunsignedshortWORD;

typedefunsignedintDWORD;

下面的申明可使數(shù)據(jù)類型具有史豐富的含義。

typedeffloatDISTANCE;

typedeffloatSCORE;

V25-15:當(dāng)申明用于分布式環(huán)境或不一樣CRU間通信環(huán)境的數(shù)據(jù)構(gòu)造時(shí),必須考慮機(jī)器的字節(jié)

次序、使用的位域及字節(jié)對(duì)齊等問(wèn)題。

闡明：例如工ntelCPU與68360CPU,在處理位域及整數(shù)時(shí)，其在內(nèi)存寄存日勺“次序”

恰好相反。

示例：假如有如下短整數(shù)及構(gòu)造。

unsignedshortintexam;

typedefstructEXAM_BIT_STRU

(/*Intel68360*/

unsignedintAl:1;/*bit07*/

unsignedintA2:1;/*bit16*/

unsignedintA3:1;/*bit25*/

}EXAMBIT;

如下是工ntelCPU生成短整數(shù)及位域的方式。

內(nèi)存：012...（從低到高，以字節(jié)為單位）

examexam低字節(jié)exam高字節(jié)

內(nèi)存：Obit1bit2bit...（字節(jié)的各“位”）

EXAM_BITAlA2A3

如下是68360CPU生成短整數(shù)及位域的方式。

內(nèi)存：012（從低到高，以字節(jié)為單位）

examexam高字節(jié)exam低字節(jié)

內(nèi)存：7bit6bit5bit（字節(jié)的各“位”）

EXAM_BITAlA2A3

闡明：在對(duì)齊方式下，CPUH勺運(yùn)行效率要快得多。

示例：如下圖，當(dāng)一種long型數(shù)（如圖中10ng1）在內(nèi)存中II勺位置恰好與內(nèi)存的字邊界

對(duì)齊時(shí)，CPU存取這個(gè)數(shù)只需訪問(wèn)一次內(nèi)存，而當(dāng)一種long型數(shù)（如圖中的10ng2）在

內(nèi)存中口勺位置跨越了字邊界時(shí)，CPU存取這個(gè)數(shù)就需要多次訪問(wèn)內(nèi)存，如i960cx訪問(wèn)這

樣B勺數(shù)需讀內(nèi)存三次（?種BYTE、-種SHORT、?種BYTE,由CPU的微代碼執(zhí)行，對(duì)

軟件透明），所有對(duì)齊方式下CPU的運(yùn)行效率明顯快多了。

18162432

Ilongl|longlIlongl|longl|

Ilong2|

|long2|long2|long2|

6函數(shù)、過(guò)程

'6-1：對(duì)所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理。

4-2：明確函數(shù)功能，精確(而不是近似)地實(shí)現(xiàn)函數(shù)設(shè)計(jì)。

Y-3:編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用(如編寫C/C++語(yǔ)言的可重入函數(shù)時(shí)，應(yīng)使

用aut。即缺省態(tài)局部變量或寄存器變量)。

闡明：編寫C/C++語(yǔ)言日勺可重入函數(shù)時(shí)，不應(yīng)使用static局部變量，否則必須通過(guò)特殊

處理，才能使函數(shù)具有可重入性。

?-4：編寫可重入函數(shù)時(shí)，若使用全局變量，則應(yīng)通過(guò)關(guān)中斷、信號(hào)量(即P、V操作)等手段

對(duì)其加以保護(hù)。

闡明：若對(duì)所使用的全局變量不加以保護(hù)，則此函數(shù)就不具有可重入性，即當(dāng)多種進(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ù)若被多種進(jìn)程調(diào)用H勺話，其成果也許是未知的，由于當(dāng)(**)語(yǔ)句剛執(zhí)行完后，此

外一種使用本函數(shù)日勺進(jìn)程也許恰好被激活，那么當(dāng)新激活口勺進(jìn)程執(zhí)行到此函數(shù)時(shí)，將使

Exam賦與另一種不一樣的Jpara值，因此當(dāng)控制重新回到"temp=Square_Exam()”

后，計(jì)算出的temp很也許不是預(yù)想中的成果。此函數(shù)應(yīng)如下改善。

unsignedintexample(intpara)

(

unsignedinttemp;

［申請(qǐng)信號(hào)量操作］//若申請(qǐng)不到“信號(hào)量”，闡明此外的進(jìn)程正處在

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

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;

}

'6-5:在同一項(xiàng)目組應(yīng)明確規(guī)定對(duì)接口函數(shù)參數(shù)的J合法性檢查應(yīng)由函數(shù)的調(diào)用者負(fù)責(zé)還是由接

□函數(shù)自身負(fù)責(zé)，缺省是由函數(shù)調(diào)用者負(fù)責(zé)。

闡明：對(duì)于模塊間接口函數(shù)n勺參數(shù)n勺合法性檢查這一問(wèn)題，往往有兩個(gè)極端現(xiàn)象，即：要

么是調(diào)用者和被調(diào)用者對(duì)參數(shù)均不作合法性檢查，成果就遺漏了合法性檢查這一必要的處

理過(guò)程，導(dǎo)致問(wèn)題隱患；要么就是調(diào)用者和被調(diào)用者均對(duì)參數(shù)進(jìn)行合法性檢查，這種狀況

雖不會(huì)導(dǎo)致問(wèn)題，但產(chǎn)生了冗余代碼，減少了效率。

1/26-1：防止將函數(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成了工作變量，不太好。

)

)

若改為如下，則更好些。

voidsum_data(unsignedintnum,int*datazint*sum)

(

unsignedintcount;

intsum_temp;

sum_temp=0;

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

sumtemp+=data[count];

)

sum=sum_temp;

%6?2：函數(shù)的!規(guī)模盡量限制在200行以內(nèi)。

闡明：