堅(jiān)果內(nèi)核變量居然使用拼音命名！還拼錯(cuò)了！如何規(guī)范C語(yǔ)言編程？

作者：付斌

不久前，錘子科技天貓官方旗艦店商品全線下架，錘子科技商城的多款手機(jī)也顯示為“到貨通知”。錘子可以的前途渺茫。

小米9發(fā)布后，其開源了小米9穩(wěn)定版內(nèi)核代碼，同時(shí)，開發(fā)者發(fā)現(xiàn)，錘子科技的多款手機(jī)內(nèi)核代碼也已經(jīng)在 Github 上開源，包括 Smartian T1、T2、M1、M1L，以及堅(jiān)果系列。

小米9內(nèi)核地址：https://github.com/MiCode/Xiaomi_Kernel_OpenSource/tree/cepheus-p-oss

堅(jiān)果系列內(nèi)核地址：https://github.com/SmartisanTech/SmartisanOS_Kernel_Source

代碼公開后，錘子科技貼吧名為jocover的網(wǎng)友吐槽說(shuō)，代碼中變量居然用拼音命名！

該網(wǎng)友表示，誰(shuí)知道fenbianlu是啥玩意？而且代碼里一堆日期標(biāo)注，難道錘子連git代碼管理都不會(huì)用了？這是背光的驅(qū)動(dòng)，為ODM公司所寫，不過(guò)這個(gè)fenbianlu是錘科的天才lishaokai改的，看注釋，還有個(gè)變量temp也無(wú)力吐槽，加了倆變量還加成這樣，我佛了。

或許是一時(shí)疏忽將fenbianlv打錯(cuò)了，也或許是拼音+英文創(chuàng)造出fenbian+luminance。

有人表示上市公司其實(shí)拼音英語(yǔ)雙標(biāo)的情況屢見不鮮，也有人表示這樣做未免有點(diǎn)不夠國(guó)際化，還有人表示，拼音怎么了，能用不就就行了。當(dāng)然，這也給黑粉趁虛而入的機(jī)會(huì)：“居然沒能寫成日文，羅老師一定很不開心”。

接下來(lái)代碼又被扒出CPU作弊。如下圖，代碼寫了一大堆，其實(shí)就是把boost時(shí)間加個(gè)5毫秒的樣子，號(hào)稱smartisan cpu boost。據(jù)猜測(cè)，為動(dòng)畫效果提供時(shí)鐘延遲，為了界面看起來(lái)漂亮。

另外，還有用堅(jiān)果R1電池，另外有個(gè)670的方案，估計(jì)和T2的810版本一樣難產(chǎn)不見。

據(jù)悉，阿里巴巴、華為等公司嚴(yán)禁拼音與英文混合的方式命名，另外，還強(qiáng)制要求避免采用純拼音方式命名。雖然這些的確可能不會(huì)影響到程序的運(yùn)行，但作為嚴(yán)謹(jǐn)嚴(yán)肅的程序員，優(yōu)質(zhì)的程序需要精心的雕琢，應(yīng)該盡量避免這種情況。網(wǎng)友表示，這種三流程序員就不要多說(shuō)了，可能連阿里一面都過(guò)不了。

那么該如何規(guī)范C語(yǔ)言編程？此前嵌入式ARM曾多次發(fā)布此類文章：

嵌入式軟件開發(fā)編程規(guī)范你了解嗎？小心吃大虧

嚴(yán)于律己!寫給自己的C++編程規(guī)范

養(yǎng)成良好的嵌入式C代碼編碼習(xí)慣要遵循哪些規(guī)則？

今天，讓我們?cè)賮?lái)學(xué)習(xí)一下華為的C語(yǔ)言編程規(guī)范（來(lái)源網(wǎng)絡(luò)）：

1 排版

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

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

1-2：相對(duì)獨(dú)立的程序塊之間、變量說(shuō)明之后必須加空行。如下例子不符合規(guī)范：

if (!valid_ni(ni))

{

... // program code

}

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

應(yīng)如下書寫：

if (!valid_ni(ni))

{

... // program code

}

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

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

1-4：不允許把多個(gè)短語(yǔ)句寫在一行中，即一行只寫一條語(yǔ)句。如下例子不符合規(guī)范：

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

應(yīng)如下書寫：

rect.length= 0;

rect.width =0;

1-5：if、for、do、while、case、switch、default等語(yǔ)句自占一行，且if、for、do、while等語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào){}。如下例子不符合規(guī)范：

if (pUserCR== NULL) return;

應(yīng)如下書寫：

if (pUserCR== NULL)

{

return;

}

1-6：對(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-7：函數(shù)或過(guò)程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格，case語(yǔ)句下的情況處理語(yǔ)句也要遵從語(yǔ)句縮進(jìn)要求。

1-8：程序塊的分界符（如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 (...) {

... //program code

}

if (...)

{

... //program code

}

voidexample_fun( void )

{

... //program code

}

應(yīng)如下書寫：

for (...)

{

... //program code

}

if (...)

{

... //program code

}

voidexample_fun( void )

{

... //program code

}

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

2 注釋

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

說(shuō)明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。

2-2：文件頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、內(nèi)容、功能、修改日志等。

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

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

Copyright: 1988-1999, Huawei Tech. Co., Ltd.

File name: 文件名

Description: 用于詳細(xì)說(shuō)明此程序文件完成的主要功能，與其他模塊或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系

Author: 作者

Version: 版本

Date: 完成日期

History: 修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述。

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

2-3：函數(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ù)清單

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

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

Table Updated: // 被修改的表（此項(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ō)明

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

2-4：邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。

2-5：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。

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

2-6：注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語(yǔ)句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。如下例子不符合規(guī)范：

例1：

/* getreplicate sub system index and net indicator */

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;

/* getreplicate sub system index and net indicator */

應(yīng)如下書寫：

/* getreplicate sub system index and net indicator */

repssn_ind =ssn_data[index].repssn_index;

repssn_ni =ssn_data[index].ni;

2-7：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說(shuō)明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。示例：

/* activestatistic task number */

#defineMAX_ACT_TASK_NUMBER 1000

#defineMAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

2-8：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方。

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

/* sccpinterface with sccp user primitive message name */

enumSCCP_USER_PRIMITIVE

{

N_UNITDATA_IND, /* sccp notify sccp user unit data come*/

N_NOTICE_IND, /* sccp notify user the No.7 network cannot */

/* transmission this message */

N_UNITDATA_REQ, /* sccp user's unit data transmissionrequest*/

};

2-9：全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。示例：

/* TheErrorCode when SCCP translate */

/* GlobalTitle failure, as follows */ // 變量作用、含義

/* 0 － SUCCESS 1 － GT Table error */

/* 2 － GT error Others － no use */ // 變量取值范圍

/* onlyfunction SCCPTranslate() in */

/* thismodual can modify it, and other */

/* modulecan visit it through call */

/* thefunction GetGTTransErrorCode() */ // 使用方法

BYTEg_GTTranErrorCode;

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

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

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

voidexample_fun( void )

{

/* code one comments */

CodeBlock One

/* code two comments */

CodeBlock Two

}

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

voidexample_fun( void )

{

/* code one comments */

CodeBlock One

/* code two comments */

CodeBlock Two

}

2-11：避免在一行代碼或表達(dá)式的中間插入注釋。

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

2-12：通過(guò)對(duì)函數(shù)或過(guò)程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。

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

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

說(shuō)明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。

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

/* ifreceive_flag is TRUE */

if(receive_flag)

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

/* if mtpreceive a message from links */

if(receive_flag)

2-14：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。

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

if (...)

{

// programcode

while (index< MAX_INDEX)

{

// programcode

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

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

2-15：注釋格式盡量統(tǒng)一，建議使用“/* …… */”。

2-16：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語(yǔ)言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。

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

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

3-1：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。

說(shuō)明：較短的單詞可通過(guò)去掉“元音”形成縮寫；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。示例：如下單詞的縮寫能夠被大家基本認(rèn)可。

temp 可縮寫為 tmp ;

flag 可縮寫為 flg ;

statistic 可縮寫為 stat ;

increment 可縮寫為 inc ;

message 可縮寫為 msg ;

3-2：命名中若使用特殊約定或縮寫，則要有注釋說(shuō)明。

說(shuō)明：應(yīng)該在源文件的開始之處，對(duì)文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說(shuō)明。

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

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

3-4：對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k 作局部循環(huán)變量是允許的。

說(shuō)明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i 寫成j），而編譯時(shí)又檢查不出來(lái)，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。

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

intliv_Width

其變量名解釋如下：

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

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

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

Width 變量含義

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

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 允許。

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

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

#define_EXAMPLE_0_TEST_

#define_EXAMPLE_1_TEST_

voidset_sls00( BYTE sls );

應(yīng)改為有意義的單詞命名

#define_EXAMPLE_UNIT_TEST_

#define _EXAMPLE_ASSERT_TEST_

voidset_udt_msg_sls( BYTE sls );

3-7：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突。

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

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

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

add / removebegin / end create / destroy

insert /delete first / last get / release

increment /decrement put / get

add / deletelock / unlock open / close

min / maxold / new start / stop

next /previous source / target show / hide

send /receive source / destination

cut / pasteup / down

示例：

int min_sum;

int max_sum;

intadd_user( BYTE *user_name );

intdelete_user( BYTE *user_name );

3-9：除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義。

4 可讀性

4-1：注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。

說(shuō)明：防止閱讀程序時(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 | 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 = a | （b < c） & d，(3)造成了判斷條件出錯(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;

... //program code

}

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

#defineTRUNK_IDLE 0

#defineTRUNK_BUSY 1

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

{

Trunk[index].trunk_state= TRUNK_BUSY;

//program code

}

4-3：源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。

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

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

rect.length= 10;

char_poi =str;

rect.width =5;

若按如下形式書寫，可能更清晰一些。

rect.length= 10;

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

char_poi =str;

4-4：不要使用難懂的技巧性很高的語(yǔ)句，除非很有必要時(shí)。

說(shuō)明：高技巧語(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; ”

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

5-1：去掉沒必要的公共變量。

說(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)系，如訪問、修改及創(chuàng)建等。

說(shuō)明：明確過(guò)程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以及代碼維護(hù)等。這種關(guān)系的說(shuō)明可在注釋或文檔中描述。

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

RELATIONSystem_Init Input_Rec Print_Rec Stat_Score Student 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ù)的難度。

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

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

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

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

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

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

5-7：結(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)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。

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

typedefstruct STUDENT_STRU

{

unsignedchar name[8]; /* student's name */

unsignedchar age; /* student's age */

unsignedchar sex; /* student's sex, as follows */

/* 0 -FEMALE; 1 - MALE */

unsignedchar

teacher_name[8];/* the student teacher's name */

unisgnedchar

teacher_sex;/* his teacher sex */

} STUDENT;

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

typedefstruct TEACHER_STRU

{

unsignedchar name[8]; /* teacher name */

unisgnedchar sex; /* teacher sex, as follows */

/* 0 -FEMALE; 1 - MALE */

} TEACHER;

typedefstruct STUDENT_STRU

{

unsignedchar name[8]; /* student's name */

unsignedchar age; /* student's age */

unsignedchar sex; /* student's sex, as follows */

/* 0 -FEMALE; 1 - MALE */

unsigned intteacher_ind; /* his teacher index */

} STUDENT;

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

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

5-9：不同結(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)造不合理。

typedefstruct PERSON_ONE_STRU

{

unsignedchar name[8];

unsignedchar addr[40];

unsignedchar sex;

unsignedchar city[15];

}PERSON_ONE;

typedefstruct PERSON_TWO_STRU

{

unsignedchar name[8];

unsignedchar age;

unsignedchar tel;

}PERSON_TWO;

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

typedefstruct PERSON_STRU

{

unsignedchar name[8];

unsignedchar age;

unsignedchar sex;

unsignedchar addr[40];

unsignedchar city[15];

unsignedchar tel;

} PERSON;

5-10：結(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ì)之劃分。

typedefstruct PERSON_BASE_INFO_STRU

{

unsignedchar name[8];

unsignedchar age;

unsignedchar sex;

}PERSON_BASE_INFO;

typedefstruct PERSON_ADDRESS_STRU

{

unsignedchar addr[40];

unsignedchar city[15];

unsignedchar tel;

}PERSON_ADDRESS;

typedefstruct PERSON_STRU

{

PERSON_BASE_INFOperson_base;

PERSON_ADDRESSperson_addr;

} PERSON;

5-11：仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象。

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

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

typedefstruct EXAMPLE_STRU

{

unsigned intvalid: 1;

PERSONperson;

unsigned intset_flg: 1;

} EXAMPLE;

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

typedefstruct EXAMPLE_STRU

{

unsigned intvalid: 1;

unsigned intset_flg: 1;

PERSONperson ;

} EXAMPLE;

5-12：編程時(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-13：對(duì)編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認(rèn)識(shí)。

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

char chr;

unsignedshort int exam;

chr = -1;

exam = chr;// 編譯器不產(chǎn)生告警，此時(shí)exam 為0xFFFF。

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

5-15：合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換。

5-16：對(duì)自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一。

說(shuō)明：使用自定義類型，可以彌補(bǔ)編程語(yǔ)言提供類型少、信息量不足的缺點(diǎn)，并能使程序清晰、簡(jiǎn)潔。

示例：可參考如下方式聲明自定義數(shù)據(jù)類型。下面的聲明可使數(shù)據(jù)類型的使用簡(jiǎn)潔、明了。

typedefunsigned char BYTE;

typedefunsigned short WORD;

typedefunsigned int DWORD;

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

typedeffloat DISTANCE;

typedeffloat SCORE;

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

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

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

6-3：編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用（如編寫C/C++語(yǔ)言的可重入函數(shù)時(shí)，應(yīng)使用auto 即缺省態(tài)局部變量或寄存器變量）。

說(shuō)明：編寫C/C++語(yǔ)言的可重入函數(shù)時(shí)，不應(yīng)使用static 局部變量，否則必須經(jīng)過(guò)特殊處理，才能使函數(shù)具有可重入性。

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

說(shuō)明：若對(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ù)不具有可重入性。

unsigned intexample( int para )

{

unsigned inttemp;

Exam = para;// （**）

temp =Square_Exam( );

return temp;

}

此函數(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)。

unsigned intexample( int para )

{

unsigned inttemp;

[申請(qǐng)信號(hào)量操作] // 若申請(qǐng)不到“信號(hào)量”，說(shuō)明另外的進(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)。

return temp;

}

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é)。

說(shuō)明：對(duì)于模塊間接口函數(shù)的參數(shù)的合法性檢查這一問題，往往有兩個(gè)極端現(xiàn)象，即：要么是調(diào)用者和被調(diào)用者對(duì)參數(shù)均不作合法性檢查，結(jié)果就遺漏了合法性檢查這一必要的處理過(guò)程，造成問題隱患；要么就是調(diào)用者和被調(diào)用者均對(duì)參數(shù)進(jìn)行合法性檢查，這種情況雖不會(huì)造成問題，但產(chǎn)生了冗余代碼，降低了效率。

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

說(shuō)明：不包括注釋和空格行。

6-7：一個(gè)函數(shù)僅完成一件功能，不要設(shè)計(jì)多用途面面俱到的函數(shù)。

說(shuō)明：多功能集于一身的函數(shù)，很可能使函數(shù)的理解、測(cè)試、維護(hù)等變得困難。

6-8：函數(shù)的功能應(yīng)該是可以預(yù)測(cè)的，也就是只要輸入數(shù)據(jù)相同就應(yīng)產(chǎn)生同樣的輸出。

說(shuō)明：帶有內(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è)的。

unsigned intinteger_sum( unsigned int base )

{

unsigned intindex;

staticunsigned int sum = 0; // 注意，是static 類型的。

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

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

{

sum +=index;

}

return sum;

}

6-9：盡量不要編寫依賴于其他函數(shù)內(nèi)部實(shí)現(xiàn)的函數(shù)。

說(shuō)明：此條為函數(shù)獨(dú)立性的基本要求。由于目前大部分高級(jí)語(yǔ)言都是結(jié)構(gòu)化的，所以通過(guò)具體語(yǔ)言的語(yǔ)法要求與編譯器功能，基本就可以防止這種情況發(fā)生。但在匯編語(yǔ)言中，由于其靈活性，很可能使函數(shù)出現(xiàn)這種情況。

示例：如下是在DOS下TASM的匯編程序例子。過(guò)程Print_Msg的實(shí)現(xiàn)依賴于Input_Msg的具體實(shí)現(xiàn)，這種程序是非結(jié)構(gòu)化的，難以維護(hù)、修改。

... // 程序代碼

procPrint_Msg // 過(guò)程（函數(shù)）Print_Msg

... // 程序代碼

jmp LABEL

... // 程序代碼

endp

procInput_Msg // 過(guò)程（函數(shù)）Input_Msg

... // 程序代碼

LABEL:

... // 程序代碼

endp

6-10：檢查函數(shù)所有參數(shù)輸入的有效性。

6-11：檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等。

說(shuō)明：函數(shù)的輸入主要有兩種：一種是參數(shù)輸入；另一種是全局變量、數(shù)據(jù)文件的輸入，即非參數(shù)輸入。函數(shù)在使用輸入之前，應(yīng)進(jìn)行必要的檢查。

6-12：函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能。

6-13：使用動(dòng)賓詞組為執(zhí)行某操作的函數(shù)命名。如果是OOP方法，可以只有動(dòng)詞（名詞是對(duì)象本身）。

示例：參照如下方式命名函數(shù)。

voidprint_record( unsigned int rec_ind ) ;

intinput_record( void ) ;

unsignedchar get_current_color( void ) ;

6-14：避免使用無(wú)意義或含義不清的動(dòng)詞為函數(shù)命名。

說(shuō)明：避免用含義不清的動(dòng)詞如process、handle 等為函數(shù)命名，因?yàn)檫@些動(dòng)詞并沒有說(shuō)明要具體做什么。

6-15：函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯(cuò)誤情況。

說(shuō)明：函數(shù)的每種出錯(cuò)返回值的意義要清晰、明了、準(zhǔn)確，防止使用者誤用、理解錯(cuò)誤或忽視錯(cuò)誤返回碼。

6-16：除非必要，最好不要把與函數(shù)返回值類型不同的變量，以編譯系統(tǒng)默認(rèn)的轉(zhuǎn)換方式或強(qiáng)制的轉(zhuǎn)換方式作為返回值返回。

6-17：讓函數(shù)在調(diào)用點(diǎn)顯得易懂、容易理解。

6-18：在調(diào)用函數(shù)填寫參數(shù)時(shí)，應(yīng)盡量減少?zèng)]有必要的默認(rèn)數(shù)據(jù)類型轉(zhuǎn)換或強(qiáng)制數(shù)據(jù)類型轉(zhuǎn)換。

說(shuō)明：因?yàn)閿?shù)據(jù)類型轉(zhuǎn)換或多或少存在危險(xiǎn)。

6-19：避免函數(shù)中不必要語(yǔ)句，防止程序中的垃圾代碼。

說(shuō)明：程序中的垃圾代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測(cè)試、維護(hù)等造成不必要的麻煩。

6-20：防止把沒有關(guān)聯(lián)的語(yǔ)句放到一個(gè)函數(shù)中。

說(shuō)明：防止函數(shù)或過(guò)程內(nèi)出現(xiàn)隨機(jī)內(nèi)聚。隨機(jī)內(nèi)聚是指將沒有關(guān)聯(lián)或關(guān)聯(lián)很弱的語(yǔ)句放到同一個(gè)函數(shù)或過(guò)程中。隨機(jī)內(nèi)聚給函數(shù)或過(guò)程的維護(hù)、測(cè)試及以后的升級(jí)等造成了不便，同時(shí)也使函數(shù)或過(guò)程的功能不明確。使用隨機(jī)內(nèi)聚函數(shù)，常常容易出現(xiàn)在一種應(yīng)用場(chǎng)合需要改進(jìn)此函數(shù)，而另一種應(yīng)用場(chǎng)合又不允許這種改進(jìn)，從而陷入困境。在編程時(shí)，經(jīng)常遇到在不同函數(shù)中使用相同的代碼，許多開發(fā)人員都愿把這些代碼提出來(lái)，并構(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)聚。

應(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) */

}

6-21：如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題。

說(shuō)明：若此段代碼各語(yǔ)句之間有實(shí)質(zhì)性關(guān)聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構(gòu)造成一個(gè)新的函數(shù)。

6-22：功能不明確較小的函數(shù)，特別是僅有一個(gè)上級(jí)函數(shù)調(diào)用它時(shí)，應(yīng)考慮把它合并到上級(jí)函數(shù)中，而不必單獨(dú)存在。

說(shuō)明：模塊中函數(shù)劃分的過(guò)多，一般會(huì)使函數(shù)間的接口變得復(fù)雜。所以過(guò)小的函數(shù)，特別是扇入很低的或功能不明確的函數(shù)，不值得單獨(dú)存在。

6-23：設(shè)計(jì)高扇入、合理扇出（小于7）的函數(shù)。

說(shuō)明：扇出是指一個(gè)函數(shù)直接調(diào)用（控制）其它函數(shù)的數(shù)目，而扇入是指有多少上級(jí)函數(shù)調(diào)用它。扇出過(guò)大，表明函數(shù)過(guò)分復(fù)雜，需要控制和協(xié)調(diào)過(guò)多的下級(jí)函數(shù)；而扇出過(guò)小，如總是1，表明函數(shù)的調(diào)用層次可能過(guò)多，這樣不利程序閱讀和函數(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ù)則扇入到公共模塊中。

6-24：減少函數(shù)本身或函數(shù)間的遞歸調(diào)用。

說(shuō)明：遞歸調(diào)用特別是函數(shù)間的遞歸調(diào)用（如A->B->C->A），影響程序的可理解性；遞歸調(diào)用一般都占用較多的系統(tǒng)資源（如棧空間）；遞歸調(diào)用對(duì)程序的測(cè)試有一定影響。故除非為某些算法或功能的實(shí)現(xiàn)方便，應(yīng)減少?zèng)]必要的遞歸調(diào)用。

6-26：改進(jìn)模塊中函數(shù)的結(jié)構(gòu)，降低函數(shù)間的耦合度，并提高函數(shù)的獨(dú)立性以及代碼可讀性、效率和可維護(hù)性。優(yōu)化函數(shù)結(jié)構(gòu)時(shí)，要遵守以下原則：

（1）不能影響模塊功能的實(shí)現(xiàn)。

（2）仔細(xì)考查模塊或函數(shù)出錯(cuò)處理及模塊的性能要求并進(jìn)行完善。

（3）通過(guò)分解或合并函數(shù)來(lái)改進(jìn)軟件結(jié)構(gòu)。

（4）考查函數(shù)的規(guī)模，過(guò)大的要進(jìn)行分解。

（5）降低函數(shù)間接口的復(fù)雜度。

（6）不同層次的函數(shù)調(diào)用要有較合理的扇入、扇出。

（7）函數(shù)功能應(yīng)可預(yù)測(cè)。

（8）提高函數(shù)內(nèi)聚。（單一功能的函數(shù)內(nèi)聚最高）

說(shuō)明：對(duì)初步劃分后的函數(shù)結(jié)構(gòu)應(yīng)進(jìn)行改進(jìn)、優(yōu)化，使之更為合理。

6-27：在多任務(wù)操作系統(tǒng)的環(huán)境下編程，要注意函數(shù)可重入性的構(gòu)造。

說(shuō)明：可重入性是指函數(shù)可以被多個(gè)任務(wù)進(jìn)程調(diào)用。在多任務(wù)操作系統(tǒng)中，函數(shù)是否具有可重入性是非常重要的，因?yàn)檫@是多個(gè)進(jìn)程可以共用此函數(shù)的必要條件。另外，編譯器是否提供可重入函數(shù)庫(kù)，與它所服務(wù)的操作系統(tǒng)有關(guān)，只有操作系統(tǒng)是多任務(wù)時(shí)，編譯器才有可能提供可重入函數(shù)庫(kù)。如DOS 下BC 和MSC 等就不具備可重入函數(shù)庫(kù)，因?yàn)镈OS 是單用戶單任務(wù)操作系統(tǒng)。

6-28：避免使用BOOL參數(shù)。

說(shuō)明：原因有二，其一是BOOL參數(shù)值無(wú)意義，TURE/FALSE的含義是非常模糊的，在調(diào)用時(shí)很難知道該參數(shù)到底傳達(dá)的是什么意思；其二是BOOL參數(shù)值不利于擴(kuò)充。還有NULL也是一個(gè)無(wú)意義的單詞。

6-29：對(duì)于提供了返回值的函數(shù)，在引用時(shí)最好使用其返回值。

6-30：當(dāng)一個(gè)過(guò)程（函數(shù)）中對(duì)較長(zhǎng)變量（一般是結(jié)構(gòu)的成員）有較多引用時(shí)，可以用一個(gè)意義相當(dāng)?shù)暮甏妗?/span>

說(shuō)明：這樣可以增加編程效率和程序的可讀性。

示例：在某過(guò)程中較多引用TheReceiveBuffer[FirstSocket].byDataPtr，則可以通過(guò)以下宏定義來(lái)代替：

# definepSOCKDATA TheReceiveBuffer[FirstScoket].byDataPtr

7 程序效率

7-1：編程時(shí)要經(jīng)常注意代碼的效率。

說(shuō)明：代碼效率分為全局效率、局部效率、時(shí)間效率及空間效率。全局效率是站在整個(gè)系統(tǒng)的角度上的系統(tǒng)效率；局部效率是站在模塊或函數(shù)角度上的效率；時(shí)間效率是程序處理輸入任務(wù)所需的時(shí)間長(zhǎng)短；空間效率是程序所需內(nèi)存空間，如機(jī)器代碼空間大小、數(shù)據(jù)空間大小、?？臻g大小等。

7-2：在保證軟件系統(tǒng)的正確性、穩(wěn)定性、可讀性及可測(cè)性的前提下，提高代碼效率。

說(shuō)明：不能一味地追求代碼效率，而對(duì)軟件的正確性、穩(wěn)定性、可讀性及可測(cè)性造成影響。

7-3：局部效率應(yīng)為全局效率服務(wù)，不能因?yàn)樘岣呔植啃识鴮?duì)全局效率造成影響。

7-4：通過(guò)對(duì)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進(jìn)，以及對(duì)程序算法的優(yōu)化來(lái)提高空間效率。

說(shuō)明：這種方式是解決軟件空間效率的根本辦法。

示例：如下記錄學(xué)生學(xué)習(xí)成績(jī)的結(jié)構(gòu)不合理。

typedefunsigned char BYTE;

typedefunsigned short WORD;

typedefstruct STUDENT_SCORE_STRU

BYTEname[8];

BYTE age;

BYTE sex;

BYTE class;

BYTEsubject;

float score;

}STUDENT_SCORE;

因?yàn)槊课粚W(xué)生都有多科學(xué)習(xí)成績(jī)，故如上結(jié)構(gòu)將占用較大空間。應(yīng)如下改進(jìn)（分為兩個(gè)結(jié)構(gòu)），總的存貯空間將變小，操作也變得更方便。

typedefstruct STUDENT_STRU

{

BYTEname[8];

BYTE age;

BYTE sex;

BYTE class;

} STUDENT;

typedefstruct STUDENT_SCORE_STRU

{

WORDstudent_index;

BYTEsubject;

float score;

}STUDENT_SCORE;

7-5：循環(huán)體內(nèi)工作量最小化。

說(shuō)明：應(yīng)仔細(xì)考慮循環(huán)體內(nèi)的語(yǔ)句是否可以放在循環(huán)體之外，使循環(huán)體內(nèi)工作量最小，從而提高程序的時(shí)間效率。

示例：如下代碼效率不高。

for (ind =0; ind < MAX_ADD_NUMBER; ind++)

{

sum += ind;

back_sum = sum; /* backup sum */

}

語(yǔ)句“back_sum = sum;”完全可以放在for 語(yǔ)句之后，如下。

for (ind =0; ind < MAX_ADD_NUMBER; ind++)

{

sum+= ind;

}

back_sum =sum; /* backup sum */

7-6：仔細(xì)分析有關(guān)算法，并進(jìn)行優(yōu)化。仔細(xì)考查、分析系統(tǒng)及模塊處理輸入（如事務(wù)、消息等）的方式，并加以改進(jìn)。

7-7：對(duì)模塊中函數(shù)的劃分及組織方式進(jìn)行分析、優(yōu)化，改進(jìn)模塊中函數(shù)的組織結(jié)構(gòu)，提高程序效率。

說(shuō)明：軟件系統(tǒng)的效率主要與算法、處理任務(wù)方式、系統(tǒng)功能及函數(shù)結(jié)構(gòu)有很大關(guān)系，僅在代碼上下功夫一般不能解決根本問題。

7-8：編程時(shí)，要隨時(shí)留心代碼效率；優(yōu)化代碼時(shí)，要考慮周全。

7-9：不應(yīng)花過(guò)多的時(shí)間拼命地提高調(diào)用不很頻繁的函數(shù)代碼效率。

說(shuō)明：對(duì)代碼優(yōu)化可提高效率，但若考慮不周很有可能引起嚴(yán)重后果。

7-10：要仔細(xì)地構(gòu)造或直接用匯編編寫調(diào)用頻繁或性能要求極高的函數(shù)。

說(shuō)明：只有對(duì)編譯系統(tǒng)產(chǎn)生機(jī)器碼的方式以及硬件系統(tǒng)較為熟悉時(shí)，才可使用匯編嵌入方式。嵌入?yún)R編可提高時(shí)間及空間效率，但也存在一定風(fēng)險(xiǎn)。

7-11：在保證程序質(zhì)量的前提下，通過(guò)壓縮代碼量、去掉不必要代碼以及減少不必要的局部和全局變量，來(lái)提高空間效率。

說(shuō)明：這種方式對(duì)提高空間效率可起到一定作用，但往往不能解決根本問題。

7-12：在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層。

說(shuō)明：減少CPU切入循環(huán)層的次數(shù)。

示例：如下代碼效率不高。

for (row =0; row < 100; row++)

{

for (col = 0; col < 5; col++)

{

sum += a[row][col];

}

}

可以改為如下方式，以提高效率。

for (col =0; col < 5; col++)

{

for (row = 0; row < 100; row++)

{

sum += a[row][col];

}

}

7-13：盡量減少循環(huán)嵌套層次。

7-14：避免循環(huán)體內(nèi)含判斷語(yǔ)句，應(yīng)將循環(huán)語(yǔ)句置于判斷語(yǔ)句的代碼塊之中。

說(shuō)明：目的是減少判斷次數(shù)。循環(huán)體中的判斷語(yǔ)句是否可以移到循環(huán)體外，要視程序的具體情況而言，一般情況，與循環(huán)變量無(wú)關(guān)的判斷語(yǔ)句可以移到循環(huán)體外，而有關(guān)的則不可以。

示例：如下代碼效率稍低。

for (ind =0; ind < MAX_RECT_NUMBER; ind++)

{

if (data_type == RECT_AREA)

{

area_sum += rect_area[ind];

}

}

else

{

rect_length_sum += rect[ind].length;

rect_width_sum += rect[ind].width;

}

因?yàn)榕袛嗾Z(yǔ)句與循環(huán)變量無(wú)關(guān)，故可如下改進(jìn)，以減少判斷次數(shù)。

if(data_type == RECT_AREA)

{

for (ind = 0; ind < MAX_RECT_NUMBER; ind++)

{

area_sum += rect_area[ind];

}

}

else

{

for (ind = 0; ind < MAX_RECT_NUMBER; ind++)

{

rect_length_sum += rect[ind].length;

rect_width_sum += rect[ind].width;

}

}

7-15：盡量用乘法或其它方法代替除法，特別是浮點(diǎn)運(yùn)算中的除法。

說(shuō)明：浮點(diǎn)運(yùn)算除法要占用較多CPU資源。

示例：如下表達(dá)式運(yùn)算可能要占較多CPU 資源。

#define PAI3.1416

radius =circle_length / (2 * PAI);

應(yīng)如下把浮點(diǎn)除法改為浮點(diǎn)乘法。

#definePAI_RECIPROCAL (1 / 3.1416 ) // 編譯器編譯時(shí)，將生成具體浮點(diǎn)數(shù)

radius =circle_length * PAI_RECIPROCAL / 2;

7-16：不要一味追求緊湊的代碼。

說(shuō)明：因?yàn)榫o湊的代碼并不代表高效的機(jī)器碼。

8 質(zhì)量保證

8-1：在軟件設(shè)計(jì)過(guò)程中構(gòu)筑軟件質(zhì)量。

8-2：代碼質(zhì)量保證優(yōu)先原則

（1）正確性，指程序要實(shí)現(xiàn)設(shè)計(jì)要求的功能。

（2）穩(wěn)定性、安全性，指程序穩(wěn)定、可靠、安全。

（3）可測(cè)試性，指程序要具有良好的可測(cè)試性。

（4）規(guī)范/可讀性，指程序書寫風(fēng)格、命名規(guī)則等要符合規(guī)范。

（5）全局效率，指軟件系統(tǒng)的整體效率。

（6）局部效率，指某個(gè)模塊/子模塊/函數(shù)的本身效率。

（7）個(gè)人表達(dá)方式/個(gè)人方便性，指?jìng)€(gè)人編程習(xí)慣。

8-3：只引用屬于自己的存貯空間。

說(shuō)明：若模塊封裝的較好，那么一般不會(huì)發(fā)生非法引用他人的空間。

8-4：防止引用已經(jīng)釋放的內(nèi)存空間。

說(shuō)明：在實(shí)際編程過(guò)程中，稍不留心就會(huì)出現(xiàn)在一個(gè)模塊中釋放了某個(gè)內(nèi)存塊（如C語(yǔ)言指針），而另一模塊在隨后的某個(gè)時(shí)刻又使用了它。要防止這種情況發(fā)生。

8-5：過(guò)程/函數(shù)中分配的內(nèi)存，在過(guò)程/函數(shù)退出之前要釋放。

8-6：過(guò)程/函數(shù)中申請(qǐng)的（為打開文件而使用的）文件句柄，在過(guò)程/函數(shù)退出之前要關(guān)閉。

說(shuō)明：分配的內(nèi)存不釋放以及文件句柄不關(guān)閉，是較常見的錯(cuò)誤，而且稍不注意就有可能發(fā)生。這類錯(cuò)誤往往會(huì)引起很嚴(yán)重后果，且難以定位。

示例：下函數(shù)在退出之前，沒有把分配的內(nèi)存釋放。

typedefunsigned char BYTE;

intexample_fun( BYTE gt_len, BYTE *gt_code )

{

BYTE *gt_buf;

gt_buf = (BYTE *) malloc (MAX_GT_LENGTH);

... //program code, include check gt_buf if or not NULL.

/* global title length error */

if (gt_len > MAX_GT_LENGTH)

{

return GT_LENGTH_ERROR; // 忘了釋放gt_buf

}

... // other program code

}

應(yīng)改為如下。

intexample_fun( BYTE gt_len, BYTE *gt_code )

{

BYTE *gt_buf;

gt_buf = (BYTE * ) malloc ( MAX_GT_LENGTH );

... // program code, include check gt_buf if or not NULL.

/* global title length error */

if (gt_len > MAX_GT_LENGTH)

{

free( gt_buf ); // 退出之前釋放gt_buf

return GT_LENGTH_ERROR;

}

... // other program code

}

8-7：防止內(nèi)存操作越界。

說(shuō)明：內(nèi)存操作主要是指對(duì)數(shù)組、指針、內(nèi)存地址等的操作。內(nèi)存操作越界是軟件系統(tǒng)主要錯(cuò)誤之一，后果往往非常嚴(yán)重，所以當(dāng)我們進(jìn)行這些操作時(shí)一定要仔細(xì)小心。

示例：假設(shè)某軟件系統(tǒng)最多可由10個(gè)用戶同時(shí)使用，用戶號(hào)為1-10，那么如下程序存在問題。

#defineMAX_USR_NUM 10

unsignedchar usr_login_flg[MAX_USR_NUM]= "";

voidset_usr_login_flg( unsigned char usr_no )

{

if (!usr_login_flg[usr_no])

{

usr_login_flg[usr_no]= TRUE;

}

}

當(dāng)usr_no 為10 時(shí)，將使用usr_login_flg 越界?？刹捎萌缦路绞浇鉀Q。

voidset_usr_login_flg( unsigned char usr_no )

{

if (!usr_login_flg[usr_no - 1])

{

usr_login_flg[usr_no - 1]= TRUE;

}

}

8-8：認(rèn)真處理程序所能遇到的各種出錯(cuò)情況。

8-9：系統(tǒng)運(yùn)行之初，要初始化有關(guān)變量及運(yùn)行環(huán)境，防止未經(jīng)初始化的變量被引用。

8-10：系統(tǒng)運(yùn)行之初，要對(duì)加載到系統(tǒng)中的數(shù)據(jù)進(jìn)行一致性檢查。

說(shuō)明：使用不一致的數(shù)據(jù)，容易使系統(tǒng)進(jìn)入混亂狀態(tài)和不可知狀態(tài)。

8-11：嚴(yán)禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置。

說(shuō)明：編程時(shí)，不能隨心所欲地更改不屬于自己模塊的有關(guān)設(shè)置如常量、數(shù)組的大小等。

8-12：不能隨意改變與其它模塊的接口。

8-13：充分了解系統(tǒng)的接口之后，再使用系統(tǒng)提供的功能。

示例：在B型機(jī)的各模塊與操作系統(tǒng)的接口函數(shù)中，有一個(gè)要由各模塊負(fù)責(zé)編寫的初始化過(guò)程，此過(guò)程在軟件系統(tǒng)加載完成后，由操作系統(tǒng)發(fā)送的初始化消息來(lái)調(diào)度。因此就涉及到初始化消息的類型與消息發(fā)送的順序問題，特別是消息順序，若沒搞清楚就開始編程，很容易引起嚴(yán)重后果。以下示例引自B 型曾出現(xiàn)過(guò)的實(shí)際代碼，其中使用了FID_FETCH_DATA與FID_INITIAL 初始化消息類型，注意B 型機(jī)的系統(tǒng)是在FID_FETCH_DATA 之前發(fā)送FID_INITIAL 的。

MIDalarm_module_list[MAX_ALARM_MID];

int FARSYS_ALARM_proc( FID function_id, int handle )

{

_UI i, j;

switch ( function_id )

{

... // program code

case FID_INITAIL:

for (i = 0; i < MAX_ALARM_MID; i++)

{

if (alarm_module_list[i]== BAM_MODULE // **）

|| (alarm_module_list[i]== LOCAL_MODULE)

{

for (j = 0; j < ALARM_CLASS_SUM; j++)

{

FAR_MALLOC( ... );

}

}

}

... // program code

break;

case FID_FETCH_DATA:

... // program code

Get_Alarm_Module( ); // 初始化alarm_module_list

break;

... // program code

}

}

由于FID_INITIAL 是在FID_FETCH_DATA 之前執(zhí)行的，而初始化alarm_module_list 是在FID_FETCH_DATA 中進(jìn)行的，故在FID_INITIAL 中（**）處引用alarm_module_list 變量時(shí)，它還沒有被初始化。這是個(gè)嚴(yán)重錯(cuò)誤。應(yīng)如下改正：要么把Get_Alarm_Module 函數(shù)放在FID_INITIAL 中（**）之前；要么就必須考慮（**）處的判斷語(yǔ)句是否可以用（不使用alarm_module_list 變量的）其它方式替代，或者是否可以取消此判斷語(yǔ)句。

8-14：編程時(shí)，要防止差1錯(cuò)誤。

說(shuō)明：此類錯(cuò)誤一般是由于把“<=”誤寫成“<”或“>=”誤寫成“>”等造成的，由此引起的后果，很多情況下是很嚴(yán)重的，所以編程時(shí)，一定要在這些地方小心。當(dāng)編完程序后，應(yīng)對(duì)這些操作符進(jìn)行徹底檢查。

8-15：要時(shí)刻注意易混淆的操作符。當(dāng)編完程序后，應(yīng)從頭至尾檢查一遍這些操作符，以防止拼寫錯(cuò)誤。

說(shuō)明：形式相近的操作符最容易引起誤用，如C/C++中的“=”與“==”、“|”與“||”、“&”與“&&”等，若拼寫錯(cuò)了，編譯器不一定能夠檢查出來(lái)。

示例：如把“&”寫成“&&”，或反之。

ret_flg =(pmsg->ret_flg & RETURN_MASK);

被寫為：

ret_flg =(pmsg->ret_flg && RETURN_MASK);

rpt_flg =(VALID_TASK_NO( taskno ) && DATA_NOT_ZERO( stat_data ));

被寫為：

rpt_flg =(VALID_TASK_NO( taskno ) & DATA_NOT_ZERO( stat_data ));

8-16：有可能的話，if語(yǔ)句盡量加上else分支，對(duì)沒有else分支的語(yǔ)句要小心對(duì)待；switch語(yǔ)句必須有default分支。

8-17：Unix下，多線程的中的子線程退出必需采用主動(dòng)退出方式，即子線程應(yīng)return出口。

8-18：不要濫用goto語(yǔ)句。

說(shuō)明：goto語(yǔ)句會(huì)破壞程序的結(jié)構(gòu)性，所以除非確實(shí)需要，最好不使用goto語(yǔ)句。

8-19：精心地構(gòu)造、劃分子模塊，并按“接口”部分及“內(nèi)核”部分合理地組織子模塊，以提高“內(nèi)核”部分的可移植性和可重用性。

說(shuō)明：對(duì)不同產(chǎn)品中的某個(gè)功能相同的模塊，若能做到其內(nèi)核部分完全或基本一致，那么無(wú)論對(duì)產(chǎn)品的測(cè)試、維護(hù)，還是對(duì)以后產(chǎn)品的升級(jí)都會(huì)有很大幫助。

8-20：精心構(gòu)造算法，并對(duì)其性能、效率進(jìn)行測(cè)試。

8-21：對(duì)較關(guān)鍵的算法最好使用其它算法來(lái)確認(rèn)。

8-22：時(shí)刻注意表達(dá)式是否會(huì)上溢、下溢。

示例：如下程序?qū)⒃斐勺兞肯乱纭?/span>

unsignedchar size ;

while(size-- >= 0) // 將出現(xiàn)下溢

{

...// program code

}

當(dāng)size 等于0時(shí)，再減1不會(huì)小于0，而是0xFF，故程序是一個(gè)死循環(huán)。應(yīng)如下修改。

char size;// 從unsigned char 改為char

while(size-- >= 0)

{

...// program code

}

8-23：使用變量時(shí)要注意其邊界值的情況。

示例：如C 語(yǔ)言中字符型變量，有效值范圍為-128到127。故以下表達(dá)式的計(jì)算存在一定風(fēng)險(xiǎn)。

char chr =127;

int sum =200;

chr += 1; //127 為chr 的邊界值，再加1 將使chr 上溢到-128，而不是128。

sum += chr;// 故sum 的結(jié)果不是328，而是72。

若chr 與sum 為同一種類型，或表達(dá)式按如下方式書寫，可能會(huì)好些。

sum = sum +chr + 1;

8-24：留心程序機(jī)器碼大?。ㄈ缰噶羁臻g大小、數(shù)據(jù)空間大小、堆?？臻g大小等）是否超出系統(tǒng)有關(guān)限制。

8-25：為用戶提供良好的接口界面，使用戶能較充分地了解系統(tǒng)內(nèi)部運(yùn)行狀態(tài)及有關(guān)系統(tǒng)出錯(cuò)情況。

8-26：系統(tǒng)應(yīng)具有一定的容錯(cuò)能力，對(duì)一些錯(cuò)誤事件（如用戶誤操作等）能進(jìn)行自動(dòng)補(bǔ)救。

8-27：對(duì)一些具有危險(xiǎn)性的操作代碼（如寫硬盤、刪數(shù)據(jù)等）要仔細(xì)考慮，防止對(duì)數(shù)據(jù)、硬件等的安全構(gòu)成危害，以提高系統(tǒng)的安全性。

8-28：使用第三方提供的軟件開發(fā)工具包或控件時(shí)，要注意以下幾點(diǎn)：

（1）充分了解應(yīng)用接口、使用環(huán)境及使用時(shí)注意事項(xiàng)。

（2）不能過(guò)分相信其正確性。

（3）除非必要，不要使用不熟悉的第三方工具包與控件。

說(shuō)明：使用工具包與控件，可加快程序開發(fā)速度，節(jié)省時(shí)間，但使用之前一定對(duì)它有較充分的了解，同時(shí)第三方工具包與控件也有可能存在問題。

8-29：資源文件（多語(yǔ)言版本支持），如果資源是對(duì)語(yǔ)言敏感的，應(yīng)讓該資源與源代碼文件脫離，具體方法有下面幾種：使用單獨(dú)的資源文件、DLL 文件或其它單獨(dú)的描述文件（如數(shù)據(jù)庫(kù)格式）

9 代碼編輯、編譯、審查

9-1：打開編譯器的所有告警開關(guān)對(duì)程序進(jìn)行編譯。

9-2：在產(chǎn)品軟件（項(xiàng)目組）中，要統(tǒng)一編譯開關(guān)選項(xiàng)。

9-3：通過(guò)代碼走讀及審查方式對(duì)代碼進(jìn)行檢查。

說(shuō)明：代碼走讀主要是對(duì)程序的編程風(fēng)格如注釋、命名等以及編程時(shí)易出錯(cuò)的內(nèi)容進(jìn)行檢查，可由開發(fā)人員自己或開發(fā)人員交叉的方式進(jìn)行；代碼審查主要是對(duì)程序?qū)崿F(xiàn)的功能及程序的穩(wěn)定性、安全性、可靠性等進(jìn)行檢查及評(píng)審，可通過(guò)自審、交叉審核或指定部門抽查等方式進(jìn)行。

9-4：測(cè)試部測(cè)試產(chǎn)品之前，應(yīng)對(duì)代碼進(jìn)行抽查及評(píng)審。

9-5：編寫代碼時(shí)要注意隨時(shí)保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼丟失。

9-6：同產(chǎn)品軟件（項(xiàng)目組）內(nèi)，最好使用相同的編輯器，并使用相同的設(shè)置選項(xiàng)。

說(shuō)明：同一項(xiàng)目組最好采用相同的智能語(yǔ)言編輯器，如Muiti Editor，Visual Editor 等，并設(shè)計(jì)、使用一套縮進(jìn)宏及注釋宏等，將縮進(jìn)等問題交由編輯器處理。

9-7：合理地設(shè)計(jì)軟件系統(tǒng)目錄，方便開發(fā)人員使用。

說(shuō)明：方便、合理的軟件系統(tǒng)目錄，可提高工作效率。目錄構(gòu)造的原則是方便有關(guān)源程序的存儲(chǔ)、查詢、編譯、鏈接等工作，同時(shí)目錄中還應(yīng)具有工作目錄----所有的編譯、鏈接等工作應(yīng)在此目錄中進(jìn)行，工具目錄----有關(guān)文件編輯器、文件查找等工具可存放在此目錄中。

9-8：某些語(yǔ)句經(jīng)編譯后產(chǎn)生告警，但如果你認(rèn)為它是正確的，那么應(yīng)通過(guò)某種手段去掉告警信息。

說(shuō)明：在Borland C/C++中，可用“#pragma warn”來(lái)關(guān)掉或打開某些告警。

示例：

#pragma warn-rvl // 關(guān)閉告警

int examples_fun(void )

{

//程序，但無(wú)return 語(yǔ)句。

}

#pragma warn+rvl // 打開告警

編譯函數(shù)examples_fun 時(shí)本應(yīng)產(chǎn)生“函數(shù)應(yīng)有返回值”告警，但由于關(guān)掉了此告警信息顯示，所以編譯時(shí)將不會(huì)產(chǎn)生此告警提示。

9-9：使用代碼檢查工具（如C 語(yǔ)言用PC-Lint）對(duì)源程序檢查。

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

10-1：單元測(cè)試要求至少達(dá)到語(yǔ)句覆蓋。

10-2：單元測(cè)試開始要跟蹤每一條語(yǔ)句，并觀察數(shù)據(jù)流及變量的變化。

10-3：清理、整理或優(yōu)化后的代碼要經(jīng)過(guò)審查及測(cè)試。

10-4：代碼版本升級(jí)要經(jīng)過(guò)嚴(yán)格測(cè)試。

10-5：使用工具軟件對(duì)代碼版本進(jìn)行維護(hù)。

10-6：正式版本上軟件的任何修改都應(yīng)有詳細(xì)的文檔記錄。

10-7：發(fā)現(xiàn)錯(cuò)誤立即修改，并且要記錄下來(lái)。

10-8：關(guān)鍵的代碼在匯編級(jí)跟蹤。

10-9：仔細(xì)設(shè)計(jì)并分析測(cè)試用例，使測(cè)試用例覆蓋盡可能多的情況，以提高測(cè)試用例的效率。

10-11：盡可能模擬出程序的各種出錯(cuò)情況，對(duì)出錯(cuò)處理代碼進(jìn)行充分的測(cè)試。

10-12：仔細(xì)測(cè)試代碼處理數(shù)據(jù)、變量的邊界情況。

10-13：保留測(cè)試信息，以便分析、總結(jié)經(jīng)驗(yàn)及進(jìn)行更充分的測(cè)試。

10-14：不應(yīng)通過(guò)“試”來(lái)解決問題，應(yīng)尋找問題的根本原因。

10-15：對(duì)自動(dòng)消失的錯(cuò)誤進(jìn)行分析，搞清楚錯(cuò)誤是如何消失的。

10-16：修改錯(cuò)誤不僅要治表，更要治本。

10-17：測(cè)試時(shí)應(yīng)設(shè)法使很少發(fā)生的事件經(jīng)常發(fā)生。

10-18：明確模塊或函數(shù)處理哪些事件，并使它們經(jīng)常發(fā)生。

10-19：堅(jiān)持在編碼階段就對(duì)代碼進(jìn)行徹底的單元測(cè)試，不要等以后的測(cè)試工作來(lái)發(fā)現(xiàn)問題。

10-20：去除代碼運(yùn)行的隨機(jī)性（如去掉無(wú)用的數(shù)據(jù)、代碼及盡可能防止并注意函數(shù)中的“內(nèi)部寄存器”等），讓函數(shù)運(yùn)行的結(jié)果可預(yù)測(cè)，并使出現(xiàn)的錯(cuò)誤可再現(xiàn)。

11 宏

11-1：用宏定義表達(dá)式時(shí)，要使用完備的括號(hào)。

示例：如下定義的宏都存在一定的風(fēng)險(xiǎn)。

#defineRECTANGLE_AREA( a, b ) a * b

#defineRECTANGLE_AREA( a, b ) (a * b)

#defineRECTANGLE_AREA( a, b ) (a) * (b)

正確的定義應(yīng)為：

#defineRECTANGLE_AREA( a, b ) ((a) * (b))

11-2：將宏所定義的多條表達(dá)式放在大括號(hào)中。

示例：下面的語(yǔ)句只有宏的第一條表達(dá)式被執(zhí)行。為了說(shuō)明問題，for語(yǔ)句的書寫稍不符規(guī)范。

#defineINTI_RECT_VALUE( a, b )

a = 0;

b = 0;

for (index =0; index < RECT_TOTAL_NUM; index++)

INTI_RECT_VALUE(rect.a, rect.b );

正確的用法應(yīng)為：

#defineINTI_RECT_VALUE( a, b )

{

a = 0;

b = 0;

}

for (index =0; index < RECT_TOTAL_NUM; index++)

{

INTI_RECT_VALUE(rect[index].a, rect[index].b );

}

11-3：使用宏時(shí)，不允許參數(shù)發(fā)生變化。

示例：如下用法可能導(dǎo)致錯(cuò)誤。

#defineSQUARE( a ) ((a) * (a))

int a = 5;

int b;

b = SQUARE(a++ ); // 結(jié)果：a = 7，即執(zhí)行了兩次增1。

正確的用法是：

b = SQUARE(a );

a++; // 結(jié)果：a = 6，即只執(zhí)行了一次增1。