目錄

1排版6

2注釋11

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

4可讀性20

5變量、結(jié)構(gòu)22

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

7可測(cè)性36

8程序效率40

9質(zhì)量保證44

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

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

12宏53

軟件編程規(guī)范總則1排版

1排版

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

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

11-2:相對(duì)獨(dú)立的程序塊之間.變■說(shuō)昭之后必須加空行.

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

if(!valid_ni(ni))

(

?..//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

應(yīng)如下書(shū)寫(xiě)

if(!valid_ni(ni))

{

???//programcode

)

repssn_ind=ssn_data[index].repssn_inciex;

repssn_ni=ssn_data[index].ni;

*1-3:較長(zhǎng)的語(yǔ)句（＞80字符）要分成多行書(shū)寫(xiě),長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作將處劃分新

行，操作將放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)牡谶M(jìn)，使^版整齊，語(yǔ)句可讀.

示例：

perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN

+STATSIZEPERFRAM*sizeof(UL

act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied

stat_poi[index].occupied;

僅供內(nèi)部使用2

軟件編程規(guī)范總則1排版

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));

僅供內(nèi)部使用3

軟件編程規(guī)范總則1排版

11-4:循環(huán).判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要迸行適應(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

)

11-5:若函數(shù)豳圾中的參數(shù)較長(zhǎng)，則要迸行適當(dāng)?shù)膭澐?

示例：

n7stat_str_compare((BYTE*)&stat_object,

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

Sizeof(_STAT_OBJECT));

n7stat_flash_act_duration(stat_itemzframe_id*STAT_TASK_CHECK_NUMBER

+index,stat_object);

*1-6:不允許把多個(gè)短語(yǔ)句寫(xiě)在一行中,即一行只寫(xiě)一條語(yǔ)句。

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

僅供內(nèi)部使用4

軟件編程規(guī)范總則1排版

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

應(yīng)如下書(shū)寫(xiě)

rect.length=0;

rect.width=0;

1-7:if、for、d。、while、case、switch、default等語(yǔ)句自占一行,且if、for、do.

while?語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào){}.

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

if(pUserCR==NULL)return;

應(yīng)如下書(shū)寫(xiě)：

if(pUserCR==NULL)

(

return;

)

11-8:對(duì)齊只使用空格罐,不使用TAB健。

說(shuō)明：以免用不同的編輯器閱讀程序時(shí)，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局

不整齊，不要使用BC作為編輯器合版本，因?yàn)锽C會(huì)自動(dòng)將8個(gè)空格變?yōu)橐粋€(gè)TAB鍵，

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

*1-9：函獻(xiàn)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格，

case逼句下的情況處理謂句由要遵從語(yǔ)句縮進(jìn)要求.

11-10：程序塊的分界將(如C/C++語(yǔ)言的場(chǎng)號(hào)‘{‘和'}')應(yīng)各獨(dú)占一行并且位于同

一列，同時(shí)與弓I用它們的語(yǔ)句左對(duì)齊.在函數(shù)體的開(kāi)始、類的定義、結(jié)構(gòu)的定義、枚舉的定義

以及if、for.do.while,switch,case語(yǔ)句中的程廉都要采用如上制臉?lè)绞?

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

僅供內(nèi)部使用5

軟件編程規(guī)范總則1排版

for(...){

.,?//programcode

}

if(…)

(

...//programcode

)

voidexample_fun(void)

(

...//programcode

)

應(yīng)如下書(shū)寫(xiě)。

for(...)

(

...//programcode

}

if(???)

(

...//programcode

)

voidexample_fun(void)

(

...//programcode

)

*1-11:在兩介以上的關(guān)健字、變常?的對(duì)等掾作時(shí)，它們之間的操作將之萌、之后

或者no后要加空格；進(jìn)田網(wǎng)等操作時(shí)，如果是關(guān)系密切的立即操作符(如->),后不聞a

空格.

說(shuō)明：采用這種松散方式編寫(xiě)代碼的目的是使代碼更加清晰。

僅供內(nèi)部使用6

軟件編程規(guī)范總則1排版

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

如果語(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è)以上空格。

示例：

(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)T、"?(地址運(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)鍵字更為突出、明顯。

僅供內(nèi)部使用7

軟件編程規(guī)范總則1排版

if(a>=b&&c>d)

%1-1：一例序以小于80^將為宣，不要耳霧過(guò)長(zhǎng).

僅供內(nèi)部使用8

軟件編程規(guī)范總則2注釋

2注釋

*2-1：mi況下,源程序有效注解?必須在如%以上.

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

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

12-2:說(shuō)明性文件(如頭文件.h文件、.inc文件、.de彼件、結(jié)譚說(shuō)明文件.cfg等)頭部應(yīng)

進(jìn)行注香，注薜必須列出：版權(quán)說(shuō)明、版本號(hào)、生成日期.作者、內(nèi)容、功幡與其它文件的

關(guān)系、修改日志等,頭文件的曲中還應(yīng)有函敷功能簡(jiǎn)要說(shuō)明.

示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要

包含在內(nèi)。

/*★**★★**★★**★★***★************************★★*****

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

Filename://文件名

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

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

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

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

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

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

1.....

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

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

1.Date:

Author:

僅供內(nèi)部使用9

軟件編程規(guī)范總則2注釋

Modification:

2..…

*************************************************/

?2-3:源文件頭部成進(jìn)行曲，列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者.模塊目的用

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

示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(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

***********************************************************/

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

它文件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及

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

12-4:函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函散的目的用繪輸入?yún)?shù)、檢出參數(shù)、返回值、憫

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

示例：下面這段函數(shù)的注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含

在內(nèi)。

僅供內(nèi)部使用10

軟件編程規(guī)范總則2注釋

/文★**★★**★★***************************************

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

Description:〃函數(shù)功能、性能等的描述

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

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

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

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

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

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

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

Return://函數(shù)返回值的說(shuō)明

Others://其它說(shuō)明

it************************************************/

*2-5:邊號(hào)代碼邊曲,修改代碼同時(shí)修改相應(yīng)的注釋,以保證注薜與代碼的一致此不

再有用的曲要I!除.

*2-6:曲的內(nèi)容要潮I、明了,含義準(zhǔn)確,防止注物二義性.

說(shuō)明：錯(cuò)誤的注釋不但無(wú)益反而有害。

規(guī)剜2-7:避免在注容中使用縮寫(xiě)，特別是三雕用縮寫(xiě).

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

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

釋）相鄰位■,不可放在下面,如放于上方剜需與其上面的代碼用空行隔開(kāi)。

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

例1：

僅供內(nèi)部使用11

軟件編程規(guī)范總則2注釋

/*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)如下書(shū)寫(xiě)

/*getreplicatesubsystemindexandnetindicator*/

repssn_ind=ssn_data[index].repssn_inciex;

repssn_ni=ssn_data[index].ni;

*2-9:對(duì)于所有有物理含義的變■、常?，如果其命名不是充分自注降的，在聲明時(shí)都必

須加以注降,說(shuō)昭英物理含義.變■、?！?、宏的注理mm如:方相鄰位?3帕方.

示例：

/*activestatistictasknumber*/

#defineMAX_ACT_TASK_NUMBER1000

#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/

12-10:聯(lián)結(jié)構(gòu)聲明（包局姆、結(jié)構(gòu).類、枚舉等），如果其命名不是充分自助的，必

須加以注明對(duì)數(shù)據(jù)結(jié)構(gòu)的注瞳在其上方相鄰位■,不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的

注薜放在此域的右方.

示例：可按如下形式說(shuō)明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。

/*seepinterfacewithseepuserprimitivemessagename*/

enumSCCP_USER_PRIMITIVE

{

N_UN1TDATA_工ND,/*seepnotifyseepuserunitdatacome*/

N_NOT工CE_工ND,/*seepnotifyusertheNo.7networkcannot*/

僅供內(nèi)部使用12

軟件編程規(guī)范總則2注釋

/*transmissionthismessage*/

N_UNITDATA_REQ,/*seepuser1sunitdatatransmissionrequest*/

?2-11:全局變細(xì)的注彩,包括對(duì)融取回5BL明酸函敷或過(guò)程存取它以

及存取時(shí)注意事項(xiàng)等的說(shuō)明.

示例：

/*TheErrorCodewhenSCCPtranslate*/

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

/*0-SUCCESS1—GTTableerror*/

GTerrorOthersnouse//變量取值范圍

/*onlyfunctionSCCPTranslate()in*/

/*thismodualcanmodifyit,andother*/

/*modulecanvisititthroughcall*/

/*thefunctionGetGTTransErrorCode()*///使用方法

BYTEg_GTTranErrorCode;

*2-12:卻與所描述內(nèi)容進(jìn)行同樣的納排.

說(shuō)明：可使程序排版整齊，并方便注釋的閱讀與理解。

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

voidexample_fun(void)

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*

CodeBlockTwo

)

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

voidexample_fun(void)

僅供內(nèi)部使用13

軟件編程規(guī)范總則2注釋

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

）

*2-13:將注陣與其上面的代碼用空行HI開(kāi).

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

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

應(yīng)如下書(shū)寫(xiě)

/*codeonecomments★/

programcodeone

/*codetwocomments*/

programcodetwo

*2-14:9■的定義和分支語(yǔ)句（條件分支、甯環(huán)語(yǔ)句等）必須編寫(xiě)注釋.

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

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

*2-15:對(duì)于switch語(yǔ)句下的case語(yǔ)句,如祟因?yàn)槌盜而況需要處理完一個(gè)case后進(jìn)入下

一個(gè)case處理，必須在incase語(yǔ)句處理完'下一個(gè)case語(yǔ)句前加上明確的注麟.

說(shuō)明：這樣比較清楚程序編寫(xiě)者的意圖，有效防止無(wú)故遺漏break語(yǔ)句。

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

caseCMD_UP:

ProcessUp（）;

僅供內(nèi)部使用14

軟件編程規(guī)范總則2注釋

break;

caseCMDDOWN:

ProcessDown();

break;

caseCMD_FWD:

ProcessFwd();

if(…)

(

break;

)

else

{

ProcessCtW^B();//nowjun^>intocaseCMD_A

}

caseCMD_A:

ProcessA();

break;

caseCMD_B:

ProcessB();

break;

caseCMD_C:

ProcessC();

break;

caseCMD_D:

ProcessD();

break;

僅供內(nèi)部使用15

軟件編程規(guī)范總則2注釋

%2-1:避免在一行代S3或表達(dá)式的中間插入注釋.

說(shuō)明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。

%2-2:通過(guò)對(duì)函敷或過(guò)程、變■、結(jié)構(gòu)等正確的命名以及合理i蠅織代碼的結(jié)構(gòu)，使代碼

成為自注釋的.

說(shuō)明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。

%2-3:在代碼的功繪意圖層次上進(jìn)行注釋，提供有用、額外的信息。

說(shuō)明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀

者理解代碼，防止沒(méi)必要的重復(fù)注釋信息。

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

/*ifreceive_flagisTRUE*/

if(receive_flag)

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

/*ifmtpreceiveamessagefromlinks*/

if(receive_flag)

%2?4:速序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序快的結(jié)束.

說(shuō)明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。

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

if(...)

(

//programcode

while(index<MAX_工NDEX)

(

//programcode

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

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

僅供內(nèi)部使用16

軟件編程規(guī)范總則2注釋

、%2-5：注冏格式盡,建議使用"/*……*r,

%2-6：注薜應(yīng)考慮程序易讀及外例E版的因素,使用的語(yǔ)言若是中、疑育的，0議多使

用中文，解硼用非常潦利準(zhǔn)確的英文表達(dá).

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

中文。

僅供內(nèi)部使用17

軟件編程規(guī)范總則3標(biāo)志符命名

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

13-1:標(biāo)識(shí)符的命名要清晰、明了，稗昭啼含義，同時(shí)使用完整的單詢的大家基本可以理

解的縮耳，避免使人產(chǎn)生源黑

說(shuō)明：較短的單詞可通過(guò)去掉"元音"形成縮寫(xiě)；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成

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

示例：如下單詞的縮寫(xiě)能夠被大家基本認(rèn)可。

temp可縮寫(xiě)為tmp;

flag可縮寫(xiě)為fig;

statistic可縮寫(xiě)為stat;

increment可縮寫(xiě)為inc;

message可縮寫(xiě)為msg;

*3-2:命名中若使用特耐定或縮■，則要有注釋說(shuō)現(xiàn)

說(shuō)明：應(yīng)該在源文件的開(kāi)始之處，對(duì)文件中所使用的縮寫(xiě)或約定，特別是特殊的縮寫(xiě)，進(jìn)

行必要的注釋說(shuō)明。

*3-3：自己特有的命名風(fēng)格,要自始至終倒A致，不可來(lái)回變化.

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

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

*3-4:對(duì)于變?命名，禁止取單今字符（如i、j、k...）,?議除了要有具體含義外，還能

表明其變■類型、數(shù)據(jù)類型等，但Lj、k作局部甯環(huán)變■是允許的.

說(shuō)明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫(xiě)成j）,而編譯

僅供內(nèi)部使用18

軟件編程規(guī)范總則3標(biāo)志符命名

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

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

intliv_Width

其變量名解釋如下：

I局部變量（Local）（其它：g全局變量（Global）...）

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

v變量（Variable）（其它：c常量（Const）...）

Width變量含義

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

*3-5:命名視范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一,比如采用UNIX

的全40加下劃線的風(fēng)格或大，J國(guó)混^的方式，不要使用大，J用與下劃線混排的方式，用作特

殊標(biāo)識(shí)如標(biāo)識(shí)成員變■或全局變■的mJRlg_,其后加上大40混排的方式是允許的.

示例：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）;

%3-2:在周一軟件產(chǎn)品內(nèi)，成趣劃■□部分標(biāo)識(shí)將（變■、結(jié)構(gòu)、函數(shù)及?！觯┑拿?

防止《甌翎￡時(shí)產(chǎn)到演.

僅供內(nèi)部使用19

軟件編程規(guī)范總則3標(biāo)志符命名

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

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

3-3：用正確的反義詞組命名H有互斥JK義的變■或相反動(dòng)作的函數(shù)等。

說(shuō)明：下面是一些在軟件中常用的反義詞組。

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);

%3-4:除了SI譚開(kāi)關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用.EXAMPLE_TEST_之類以下劃線開(kāi)

始和結(jié)尾的定義。

僅供內(nèi)部使用20

軟件編程規(guī)范總則4可讀性

4可讀性

14-1:注意運(yùn)算符的優(yōu)先殿,并用括號(hào)明麻表達(dá)式的操作■序,避免使用馱認(rèn)優(yōu)凝R.

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

示例：下列語(yǔ)句中的表達(dá)式

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

if((aIb)&&(a&c))(2)

if((a|b)<(c&d))(3)

如果書(shū)寫(xiě)為

high<<8|low

a|b&&a&c

a|b<c&d

由于

high?8|low=(high?8)low,

3Ib&&a&c=(a|b)&&(a&c)>

(1)(2)不會(huì)出錯(cuò)，但語(yǔ)句不易理解；

a|b<c&d=a(b<c)&d,(3)造成了判斷條件出錯(cuò)。

*4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來(lái)替代.涉及物理狀態(tài)或者含有物理意

義的常.，不成?1￡使用數(shù)字,必須用有意義的枚舉甄宏來(lái)代替.

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

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

{

Trunk[index].trunk_state=1;

.??//programcode

)

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

僅供內(nèi)部使用21

軟件編程規(guī)范總則4可讀性

#defineTRUNK_IDLE0

#defineTRUNK_BUSY1

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

(

Trunk[index].trunk_state=TRUNK_BUSY;

...//programcode

)

%4-i：is腹序中關(guān)系較為緊密的代碼應(yīng)盡可幗g鄰.

說(shuō)明：便于程序閱讀和查找。

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

rect.length=10;

char__poi=str;

rect.width=5;

若按如下形式書(shū)寫(xiě)，可能更清晰一些。

rect.length=10;

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

char_poi=str;

%4?2:不要使用難懂的技巧性很高的語(yǔ)句，倒而有必要時(shí)?

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

示例：如下表達(dá)式，考慮不周就可能出問(wèn)題，也較難理解。

*stat_poi+++=1;

*++stat_poi+=1;

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

*stat_poi+=1;

stat_poi++;//此二語(yǔ)句功能相當(dāng)于“*stat_poi+++=1；

僅供內(nèi)部使用22

軟件編程規(guī)范總則4可讀性

++stat_poi;

*stat_poi+=1;//此二語(yǔ)句功能相當(dāng)于“*++stat_poi+=1;

僅供內(nèi)部使用23

軟件編程規(guī)范總則5變量、結(jié)構(gòu)

5變量、結(jié)構(gòu)

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

說(shuō)明：公共變量是增大模塊間耦合的原因之,故應(yīng)減少?zèng)]必要的公共變量以降低模塊間

的耦合度。

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

說(shuō)明：在對(duì)變量聲明的同時(shí)，應(yīng)對(duì)其含義、作用及取值范圍進(jìn)行注釋說(shuō)明，同時(shí)若有必要

還應(yīng)說(shuō)明與其它變量的關(guān)系。

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

說(shuō)明：明確過(guò)程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以

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

示例：在源文件中，可按如下注釋形式說(shuō)明。

RELATIONSystem_InitInput_RecPrint_RecStat_Score

StudentCreateModifyAccessAccess

ScoreCreateModifyAccessAccess,Modify

注：RELATION為操作關(guān)系；System_Init>工nput_Rec、Print_Rec、Stat_Score

為四個(gè)不同的函數(shù)；Student、Score為兩個(gè)全局變量；Create表示創(chuàng)I建，Modify表

示修改，Access表示訪問(wèn)。

其中，函數(shù)［nput_Rec、Stat_Score都可修改變量Score,故此變量將弓I起函數(shù)間較

大的耦合，并可能增加代碼測(cè)試、維護(hù)的難度。

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

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

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

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

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

說(shuō)明：特別是在C/C++中引用未經(jīng)賦值的指針，經(jīng)常會(huì)引起系統(tǒng)崩潰。

僅供內(nèi)部使用24

軟件編程規(guī)范總則5變量、結(jié)構(gòu)

%5-1：構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建,而其余有關(guān)模塊或函數(shù)只訪問(wèn)的公共變量,

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

說(shuō)明：降低公共變量耦合度。

%5-2：使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型,盡量不要使用與具體硬件或軟件環(huán)境關(guān)系

密切的變量。

說(shuō)明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類型，有利于程序的移植。

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

voidmain()

{

registerintindex;//寄存器變量

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

???//programcode

)

%53：結(jié)構(gòu)的功能要單一,是針對(duì)一?種事務(wù)的抽象。

說(shuō)明：設(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)把描述沒(méi)有關(guān)系或關(guān)系很弱的不同事務(wù)的元

素放到同一結(jié)構(gòu)中。

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

typedefstructSTUDENT_STRU

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

unsignedcharage;/*student1sage*/

unsignedcharsex;/*student*ssex,asfollows*

/*0-FEMALE;1-MALE*/

unsignedchar

teacher_name[8];/*thestudentteacher1sname★/

unisgnedchar

teacher_sex;/*histeachersex*/

}STUDENT;

若改為如下，可能更合理些。

僅供內(nèi)部使川25

軟件編程規(guī)范總則5變量、結(jié)構(gòu)

typedefstructTEACHER_STRU

{

unsignedcharname[8];/*teachername*/

unisgnedcharsex;/*teachersex,asfollows*

/*0-FEMALE;1-MALE*/

}TEACHER;

typedefstructSTUDENT_STRU

unsignedcharname[8];/*student1sname*/

unsignedcharage;/*student1sage*/

unsignedcharsex;/*student1ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedintteacher_ind;/★■histeacherindex*/

}STUDENT;

%J：不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)。

說(shuō)明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。

%65：不同結(jié)構(gòu)間的關(guān)系不要過(guò)于復(fù)雜。

說(shuō)明：若兩個(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;

僅供內(nèi)部使川26

軟件編程規(guī)范總則5變量、結(jié)構(gòu)

由于兩個(gè)結(jié)構(gòu)都是描述同一事物的，那么不如合成一個(gè)結(jié)構(gòu)。

typedefstructPERSON_STRU

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSON;

%5-6：結(jié)構(gòu)中元素的個(gè)數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個(gè)數(shù)過(guò)多可考慮依據(jù)某種原則把元素組成不

同的子結(jié)構(gòu),以減少原結(jié)構(gòu)中元素的個(gè)數(shù)。

說(shuō)明：增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。

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

typedefstructPERSON_BASE_INFO_STRU

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

}PERSONBASEINFO；

typedefstructPERSON_ADDRESS_STRU

{

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSON_ADDRESS;

typedefstructPERSON_STRU

{

PERSON_BASE_INFOperson_base;

PERSON_ADDRESSperson_addr;

}PERSON;

僅供內(nèi)部使川27

軟件編程規(guī)范總則5變量、結(jié)構(gòu)

%37：仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序,使結(jié)構(gòu)容易理解、節(jié)省占用空間,并減少引

起誤用現(xiàn)象。

說(shuō)明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。

示例：如卜.結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。

typedefstructEXAMPLE_STRU

（

unsignedintvalid:1;

PERSONperson;

unsignedintset_flg:1;

}EXAMPLE;

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

typedefstructEXAMPLE_STRU

{

unsignedintvalid:1;

unsignedintset_f1g:1;

PERSONperson;

}EXAMPLE;

%5-8：結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級(jí),并為某些未來(lái)可能的應(yīng)用保留余

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

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

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

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

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

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

變量將在“堆棧”中生成。這些細(xì)節(jié)對(duì)程序質(zhì)量的保證非常重要。

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

說(shuō)明：當(dāng)進(jìn)行數(shù)據(jù)類型強(qiáng)制轉(zhuǎn)換時(shí)，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，

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

%5-11：對(duì)編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換,也要有充分的認(rèn)識(shí)。

示例：如卜賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。

僅供內(nèi)部使川28

軟件編程規(guī)范總則5變量、結(jié)構(gòu)

charchr;