〔一〕 =====[ 排版 ]
¹1-1 ：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4 個(gè)
說明：對于由開發(fā)工具自動(dòng)生成的代碼可以有不一致。
¹1-2 ：相對獨(dú)立的程序塊之間、變量說明之后必須加空行
示例：如下例子不符合規(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 ：較長的語句（>80 字符）要分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀
示例：
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));
¹1-4 ：循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首
示例：
if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item)))
{
... // program code
}
for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)
&& (j < NewKeyword.word_length); i++, j++)
{
... // program code
}
for (i = 0, j = 0;
(i < first_word_length) && (j < second_word_length);
i++, j++)
{
... // program code
}
¹1-5 ：若函數(shù)或過程中的參數(shù)較長，則要進(jìn)行適當(dāng)?shù)膭澐?
示例：
n7stat_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 );
¹1-6 ：不允許把多個(gè)短語句寫在一行中，即一行只寫一條語句
示例：如下例子不符合規(guī)范。
rect.length = 0; rect.width = 0;
應(yīng)如下書寫
rect.length = 0;
rect.width = 0;
¹1-7 ：if 、for 、do 、while 、case 、switch 、default 等語句自占一行，且if 、for 、do 、while 等語句的執(zhí)行語句部分無論多少都要加括號(hào){}
示例：如下例子不符合規(guī)范。
if (pUserCR == NULL) return;
應(yīng)如下書寫：
if (pUserCR == NULL)
{
return;
}
¹1-8 ：對齊只使用空格鍵，不使用TAB 鍵
說明：以免用不同的編輯器閱讀程序時(shí)，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因?yàn)?span>BC會(huì)自動(dòng)將8個(gè)空格變?yōu)橐粋€(gè)TAB鍵，因此使用BC合入的版本大多會(huì)將縮進(jìn)變亂。
¹1-9 ：函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格，case 語句下的情況處理語句也要遵從語句縮進(jìn)要求
¹1-10 ：程序塊的分界符（如C/C++ 語言的大括號(hào)‘{’ 和‘}’ ）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if 、for 、do 、while 、switch 、case 語句中的程序都要采用如上的縮進(jìn)方式
示例：如下例子不符合規(guī)范。
for (...) {
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
應(yīng)如下書寫。
for (...)
{
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
¹1-11 ：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對等操作時(shí)，如果是關(guān)系密切的立即操作符（如－> ），后不應(yīng)加空格。
說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰
由于留空格所產(chǎn)生的清晰性是相對的，所以，在已經(jīng)非常清晰的語句中沒有必要再留空格，如果語句已足夠清晰則括號(hào)內(nèi)側(cè)(即左括號(hào)后面和右括號(hào)前面)不需要加空格，多重括號(hào)間不必加空格，因?yàn)樵?span>C/C++語言中括號(hào)已經(jīng)是最清晰的標(biāo)志了。
在長語句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。
示例：
(1) 逗號(hào)、分號(hào)只在后面加空格。
int a, 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字符為宜，不要寫得過長。
〔二〕 ======[ 注釋 ]=======
¹2-1 ：一般情況下，源程序有效注釋量必須在20 ％以上
說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準(zhǔn)確、易懂、簡潔。
¹2-2 ：說明性文件（如頭文件.h 文件、.inc 文件、.def 文件、編譯說明文件.cfg 等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明
示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。
/*************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
File name: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于詳細(xì)說明此程序文件完成的主要功能，與其他模塊
// 或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控
// 制、順序、獨(dú)立或依賴等關(guān)系
Others: // 其它內(nèi)容的說明
Function List: // 主要函數(shù)列表，每條記錄應(yīng)包括函數(shù)名及功能簡要說明
1. ....
History: // 修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改
// 者及修改內(nèi)容簡述
1. Date:
Author:
Modification:
2. ...
*************************************************/
¹2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。
示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。
/************************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
FileName: test.cpp
Author: Version : Date:
Description: // 模塊描述
Version: // 版本信息
Function List: // 主要函數(shù)及其功能
1. -------
History: // 歷史修改記錄
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
說明：Description一項(xiàng)描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡述。
¹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ù)清單
Called By: // 調(diào)用本函數(shù)的函數(shù)清單
Table Accessed: // 被訪問的表（此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序）
Table Updated: // 被修改的表（此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序）
Input: // 輸入?yún)?shù)說明，包括每個(gè)參數(shù)的作
// 用、取值說明及參數(shù)間關(guān)系。
Output: // 對輸出參數(shù)的說明。
Return: // 函數(shù)返回值的說明
Others: // 其它說明
*************************************************/
¹2-5 ：邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除
¹2-6 ：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性
說明：錯(cuò)誤的注釋不但無益反而有害。
規(guī)則2-7 ：避免在注釋中使用縮寫，特別是非常用縮寫
說明：在使用縮寫時(shí)或之前，應(yīng)對縮寫進(jìn)行必要的說明。
¹2-8 ：注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開
示例：如下例子不符合規(guī)范。
例1：
/* get replicate 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;
/* get replicate sub system index and net indicator */
應(yīng)如下書寫
/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹2-9 ：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方
示例：
/* active statistic task number */
#define MAX_ACT_TASK_NUMBER 1000
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */
¹2-10 ：數(shù)據(jù)結(jié)構(gòu)聲明( 包括數(shù)組、結(jié)構(gòu)、類、枚舉等) ，如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方
示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。
/* sccp interface with sccp user primitive message name */
enum SCCP_USER_PRIMITIVE
{
N_UNITDATA_IND, /* sccp notify sccp user unit data come */
N_NOTICE_IND, /* sccp notify user the No.7 network can not */
/* transmission this message */
N_UNITDATA_REQ, /* sccp user's unit data transmission request*/
};
¹2-11 ：全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)注意事項(xiàng)等的說明
示例：
/* The ErrorCode when SCCP translate */
/* Global Title failure, as follows */ // 變量作用、含義
/* 0 － SUCCESS 1 － GT Table error */
/* 2 － GT error Others － no use */ // 變量取值范圍
/* only function SCCPTranslate() in */
/* this modual can modify it, and other */
/* module can visit it through call */
/* the function GetGTTransErrorCode() */ // 使用方法
BYTE g_GTTranErrorCode;
¹2-12 ：注釋與所描述內(nèi)容進(jìn)行同樣的縮排
說明：可使程序排版整齊，并方便注釋的閱讀與理解。
示例：如下例子，排版不整齊，閱讀稍感不方便。
void example_fun( void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
應(yīng)改為如下布局。
void example_fun( void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
¹2-13 ：將注釋與其上面的代碼用空行隔開
示例：如下例子，顯得代碼過于緊湊。
/* code one comments */
program code one
/* code two comments */
program code two
應(yīng)如下書寫
/* code one comments */
program code one
/* code two comments */
program code two
¹2-14 ：對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋
說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護(hù)人員來說，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。
¹2-15 ：對于switch 語句下的case 語句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case 后進(jìn)入下一個(gè)case 處理，必須在該case 語句處理完、下一個(gè)case 語句前加上明確的注釋
說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。
示例（注意斜體加粗部分）：
case CMD_UP:
ProcessUp();
break;
case CMD_DOWN:
ProcessDown();
break;
case CMD_FWD:
ProcessFwd();
if (...)
{
...
break;
}
else
{
ProcessCFW_B(); // now jump into case CMD_A
}
case CMD_A:
ProcessA();
break;
case CMD_B:
ProcessB();
break;
case CMD_C:
ProcessC();
break;
case CMD_D:
ProcessD();
break;
...
½2-1 ：避免在一行代碼或表達(dá)式的中間插入注釋
說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。
½2-2 ：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的
說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。
½2-3 ：在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息
說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。
示例：如下注釋意義不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注釋則給出了額外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
½2-4 ：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束
說明：當(dāng)代碼段較長，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。
示例：參見如下例子。
if (...)
{
// program code
while (index < MAX_INDEX)
{
// program code
} /* end of while (index < MAX_INDEX) */ // 指明該條while語句結(jié)束
} /* end of if (...)*/ // 指明是哪條if語句結(jié)束
½2-5 ：注釋格式盡量統(tǒng)一，建議使用“/* …… */”
½2-6 ：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)
說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護(hù)人員的考慮，建議使用中文。
〔三〕 =====[ 標(biāo)識(shí)符命名 ]=======
¹3-1 ：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解
說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。
示例：如下單詞的縮寫能夠被大家基本認(rèn)可。
temp 可縮寫為 tmp ;
flag 可縮寫為 flg ;
statistic 可縮寫為 stat ;
increment 可縮寫為 inc ;
message 可縮寫為 msg ;
¹3-2 ：命名中若使用特殊約定或縮寫，則要有注釋說明
說明：應(yīng)該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說明。
¹3-3 ：自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化
說明：個(gè)人的命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個(gè)人命名風(fēng)格）。
¹3-4 ：對于變量命名，禁止取單個(gè)字符（如i 、j 、k... ），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i 、j 、k 作局部循環(huán)變量是允許的
說明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫成j），而編譯時(shí)又檢查不出來，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。
示例：下面所示的局部變量名的定義方法可以借鑒。
int liv_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-1 ：除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符
示例：如下命名，使人產(chǎn)生疑惑。
#define _EXAMPLE_0_TEST_
#define _EXAMPLE_1_TEST_
void set_sls00( BYTE sls );
應(yīng)改為有意義的單詞命名
#define _EXAMPLE_UNIT_TEST_
#define _EXAMPLE_ASSERT_TEST_
void set_udt_msg_sls( BYTE sls );
½3-2 ：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突
說明：對接口部分的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識(shí)等。
½3-3 ：用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等
說明：下面是一些在軟件中常用的反義詞組。
add / remove begin / end create / destroy
insert / delete first / last g et / release
increment / decrement put / get
add / delete lock / unlock open / close
min / max old / new start / stop
next / previous source / target show / hide
send / receive source / destination
cut / paste up / down
示例：
int min_sum;
int max_sum;
int add_user( BYTE *user_name );
int delete_user( BYTE *user_name );
½3-4 ：除了編譯開關(guān)/ 頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_ 之類以下劃線開始和結(jié)尾的定義
〔四〕 =====[ 可讀性 ]======
¹4-1 ：注意運(yùn)算符的優(yōu)先級，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級
說明：防止閱讀程序時(shí)產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級與設(shè)計(jì)思想不符而導(dǎo)致程序出錯(cuò)。
示例：下列語句中的表達(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ò)，但語句不易理解；
a | b < c & d = a | （b < c） & d，(3)造成了判斷條件出錯(cuò)。
¹4-2 ：避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替
示例：如下的程序可讀性差。
if (Trunk[index].trunk_state == 0)
{
Trunk[index].trunk_state = 1;
... // program code
}
應(yīng)改為如下形式。
#define TRUNK_IDLE 0
#define TRUNK_BUSY 1
if (Trunk[index].trunk_state == TRUNK_IDLE)
{
Trunk[index].trunk_state = TRUNK_BUSY;
... // program code
}
½4-1 ：源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰
說明：便于程序閱讀和查找。
示例：以下代碼布局不太合理。
rect.length = 10;
char_poi = str;
rect.width = 5;
若按如下形式書寫，可能更清晰一些。
rect.length = 10;
rect.width = 5; // 矩形的長與寬關(guān)系較密切，放在一起。
char_poi = str;
½4-2 ：不要使用難懂的技巧性很高的語句，除非很有必要時(shí)
說明：高技巧語句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于算法。
示例：如下表達(dá)式，考慮不周就可能出問題，也較難理解。
* stat_poi ++ += 1;
* ++ stat_poi += 1;
應(yīng)分別改為如下:
*stat_poi += 1;
stat_poi++; // 此二語句功能相當(dāng)于“ * stat_poi ++ += 1; ”
++ stat_poi;
*stat_poi += 1; // 此二語句功能相當(dāng)于“ * ++ stat_poi += 1; ”
〔五〕 =====[ 變量、結(jié)構(gòu) ]=====
¹5-1 ：去掉沒必要的公共變量
說明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少?zèng)]必要的公共變量以降低模塊間的耦合度。
¹5-2 ：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系
說明：在對變量聲明的同時(shí)，應(yīng)對其含義、作用及取值范圍進(jìn)行注釋說明，同時(shí)若有必要還應(yīng)說明與其它變量的關(guān)系。
¹5-3 ：明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系，如訪問、修改及創(chuàng)建等
說明：明確過程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測試、系統(tǒng)聯(lián)調(diào)以及代碼維護(hù)等。這種關(guān)系的說明可在注釋或文檔中描述。
示例：在源文件中，可按如下注釋形式說明。
RELATION System_Init Input_Rec Print_Rec Stat_Score
Student Create Modify Access Access
Score 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ù)間較大的耦合，并可能增加代碼測試、維護(hù)的難度。
¹5-4 ：當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生
說明：對公共變量賦值時(shí)，若有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、穩(wěn)定性。
¹5-5 ：防止局部變量與公共變量同名
說明：若使用了較好的命名規(guī)則，那么此問題可自動(dòng)消除。
¹5-6 ：嚴(yán)禁使用未經(jīng)初始化的變量作為右值
說明：特別是在C/C++中引用未經(jīng)賦值的指針，經(jīng)常會(huì)引起系統(tǒng)崩潰。
½5-1 ：構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問的公共變量，防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象
說明：降低公共變量耦合度。
½5-2 ：使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)系密切的變量
說明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類型，有利于程序的移植。
示例：如下例子（在DOS下BC3.1環(huán)境中），在移植時(shí)可能產(chǎn)生問題。
void main()
{
register int index; // 寄存器變量
_AX = 0x4000; // _AX是BC3.1提供的寄存器“偽變量”
... // program code
}
½5-3 ：結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象
說明：設(shè)計(jì)結(jié)構(gòu)時(shí)應(yī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)不太清晰、合理。
typedef struct STUDENT_STRU
{
unsigned char name[8]; /* student's name */
unsigned char age; /* student's age */
unsigned char sex; /* student's sex, as follows */
/* 0 - FEMALE; 1 - MALE */
unsigned char
teacher_name[8]; /* the student teacher's name */
unisgned char
teacher_sex; /* his teacher sex */
} STUDENT;
若改為如下，可能更合理些。
typedef struct TEACHER_STRU
{
unsigned char name[8]; /* teacher name */
unisgned char sex; /* teacher sex, as follows */
/* 0 - FEMALE; 1 - MALE */
} TEACHER;
typedef struct STUDENT_STRU
{
unsigned char name[8]; /* student's name */
unsigned char age; /* student's age */
unsigned char sex; /* student's sex, as follows */
/* 0 - FEMALE; 1 - MALE */
unsigned int teacher_ind; /* his teacher index */
} STUDENT;
½5-4 ：不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)
說明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。
½5-5 ：不同結(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)造不合理。
typedef struct PERSON_ONE_STRU
{
unsigned char name[8];
unsigned char addr[40];
unsigned char sex;
unsigned char city[15];
} PERSON_ONE;
typedef struct PERSON_TWO_STRU
{
unsigned char name[8];
unsigned char age;
unsigned char tel;
} PERSON_TWO;
由于兩個(gè)結(jié)構(gòu)都是描述同一事物的，那么不如合成一個(gè)結(jié)構(gòu)。
typedef struct PERSON_STRU
{
unsigned char name[8];
unsigned char age;
unsigned char sex;
unsigned char addr[40];
unsigned char city[15];
unsigned char tel;
} PERSON;
½5-6 ：結(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)元素過多，那么可如下對之劃分。
typedef struct PERSON_BASE_INFO_STRU
{
unsigned char name[8];
unsigned char age;
unsigned char sex;
} PERSON_BASE_INFO;
typedef struct PERSON_ADDRESS_STRU
{
unsigned char addr[40];
unsigned char city[15];
unsigned char tel;
} PERSON_ADDRESS;
typedef struct PERSON_STRU
{
PERSON_BASE_INFO person_base;
PERSON_ADDRESS person_addr;
} PERSON;
½5-7 ：仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象
說明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。
示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。
typedef struct EXAMPLE_STRU
{
unsigned int valid: 1;
PERSON person;
unsigned int set_flg: 1;
} EXAMPLE;
若改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。
typedef struct EXAMPLE_STRU
{
unsigned int valid: 1;
unsigned int set_flg: 1;
PERSON person ;
} EXAMPLE;
½5-8 ：結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級，并為某些未來可能的應(yīng)用保留余地（如預(yù)留一些空間等）
說明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標(biāo)志之一。如果要想使產(chǎn)品具有較好的前向兼容，那么在產(chǎn)品設(shè)計(jì)之初就應(yīng)為以后版本升級保留一定余地，并且在產(chǎn)品升級時(shí)必須考慮前一版本的各種特性。
½5-9 ：留心具體語言及編譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細(xì)節(jié)
說明：如在C語言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部變量將在“堆棧”中生成。這些細(xì)節(jié)對程序質(zhì)量的保證非常重要。
½5-10 ：編程時(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é)若考慮不周，就很有可能留下隱患。
½5-11 ：對編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認(rèn)識(shí)
示例：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。
char chr;
unsigned short int exam;
chr = -1;
exam = chr; // 編譯器不產(chǎn)生告警，此時(shí)exam為0xFFFF。
½5-12 ：盡量減少?zèng)]有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換
½5-13 ：合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換
½5-14 ：對自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一
說明：使用自定義類型，可以彌補(bǔ)編程語言提供類型少、信息量不足的缺點(diǎn)，并能使程序清晰、簡潔。
示例：可參考如下方式聲明自定義數(shù)據(jù)類型。
下面的聲明可使數(shù)據(jù)類型的使用簡潔、明了。
typedef unsigned char BYTE;
typedef unsigned short WORD;
typedef unsigned int DWORD;
下面的聲明可使數(shù)據(jù)類型具有更豐富的含義。
typedef float DISTANCE;
typedef float SCORE;
½5-15 ：當(dāng)聲明用于分布式環(huán)境或不同CPU 間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時(shí)，必須考慮機(jī)器的字節(jié)順序、使用的位域及字節(jié)對齊等問題
說明：比如Intel CPU與68360 CPU，在處理位域及整數(shù)時(shí)，其在內(nèi)存存放的“順序”正好相反。
示例：假如有如下短整數(shù)及結(jié)構(gòu)。
unsigned short int exam;
typedef struct EXAM_BIT_STRU
{ /* Intel 68360 */
unsigned int A1: 1; /* bit 0 7 */
unsigned int A2: 1; /* bit 1 6 */
unsigned int A3: 1; /* bit 2 5 */
} EXAM_BIT;
如下是Intel CPU生成短整數(shù)及位域的方式。
內(nèi)存： 0 1 2 ... （從低到高，以字節(jié)為單位）
exam exam低字節(jié) exam高字節(jié)
內(nèi)存： 0 bit 1 bit 2 bit ... （字節(jié)的各“位”）
EXAM_BIT A1 A2 A3
如下是68360 CPU生成短整數(shù)及位域的方式。
內(nèi)存： 0 1 2 ... （從低到高，以字節(jié)為單位）
exam exam高字節(jié) exam低字節(jié)
內(nèi)存： 7 bit 6 bit 5 bit ... （字節(jié)的各“位”）
EXAM_BIT A1 A2 A3
說明：在對齊方式下，CPU的運(yùn)行效率要快得多。
示例：如下圖，當(dāng)一個(gè)long型數(shù)（如圖中long1）在內(nèi)存中的位置正好與內(nèi)存的字邊界對齊時(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í)行，對軟件透明），所有對齊方式下CPU的運(yùn)行效率明顯快多了。
1 8 16 24 32
------- ------- ------- -------
| long1 | long1 | long1 | long1 |
------- ------- ------- -------
| | | | long2 |
------- ------- ------- --------
| long2 | long2 | long2 | |
------- ------- ------- --------
| ....
〔六〕 =====[ 函數(shù)、過程 ]=====
¹6-1 ：對所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理
¹6-2 ：明確函數(shù)功能，精確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)
¹6-3 ：編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用（如編寫C/C++ 語言的可重入函數(shù)時(shí)，應(yīng)使用auto 即缺省態(tài)局部變量或寄存器變量）
說明：編寫C/C++語言的可重入函數(shù)時(shí)，不應(yīng)使用static局部變量，否則必須經(jīng)過特殊處理，才能使函數(shù)具有可重入性。
¹6-4 ：編寫可重入函數(shù)時(shí)，若使用全局變量，則應(yīng)通過關(guān)中斷、信號(hào)量（即P 、V 操作）等手段對其加以保護(hù)
說明：若對所使用的全局變量不加以保護(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 int example( int para )
{
unsigned int temp;
Exam = para; // （**）
temp = Square_Exam( );
return temp;
}
此函數(shù)若被多個(gè)進(jìn)程調(diào)用的話，其結(jié)果可能是未知的，因?yàn)楫?dāng)（**）語句剛執(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 int example( int para )
{
unsigned int temp;
[申請信號(hào)量操作] // 若申請不到“信號(hào)量”，說明另外的進(jìn)程正處于
Exam = para; // 給Exam賦值并計(jì)算其平方過程中（即正在使用此
temp = Square_Exam( ); // 信號(hào)），本進(jìn)程必須等待其釋放信號(hào)后，才可繼
[釋放信號(hào)量操作] // 續(xù)執(zhí)行。若申請到信號(hào)，則可繼續(xù)執(zhí)行，但其
// 它進(jìn)程必須等待本進(jìn)程釋放信號(hào)量后，才能再使
// 用本信號(hào)。
return temp;
}
¹6-5 ：在同一項(xiàng)目組應(yīng)明確規(guī)定對接口函數(shù)參數(shù)的合法性檢查應(yīng)由函數(shù)的調(diào)用者負(fù)責(zé)還是由接口函數(shù)本身負(fù)責(zé)，缺省是由函數(shù)調(diào)用者負(fù)責(zé)
說明：對于模塊間接口函數(shù)的參數(shù)的合法性檢查這一問題，往往有兩個(gè)極端現(xiàn)象，即：要么是調(diào)用者和被調(diào)用者對參數(shù)均不作合法性檢查，結(jié)果就遺漏了合法性檢查這一必要的處理過程，造成問題隱患；要么就是調(diào)用者和被調(diào)用者均對參數(shù)進(jìn)行合法性檢查，這種情況雖不會(huì)造成問題，但產(chǎn)生了冗余代碼，降低了效率。
½6-1 ：防止將函數(shù)的參數(shù)作為工作變量
說明：將函數(shù)的參數(shù)作為工作變量，有可能錯(cuò)誤地改變參數(shù)內(nèi)容，所以很危險(xiǎn)。對必須改變的參數(shù)，最好先用局部變量代之，最后再將該局部變量的內(nèi)容賦給該參數(shù)。
示例：下函數(shù)的實(shí)現(xiàn)不太好。
void sum_data( unsigned int num, int *data, int *sum )
{
unsigned int count;
*sum = 0;
for (count = 0; count < num; count++)
{
*sum += data[count]; // sum成了工作變量，不太好。
}
}
若改為如下，則更好些。
void sum_data( unsigned int num, int *data, int *sum )
{
unsigned int count ;
int sum_temp;
sum_temp = 0;
for (count = 0; count < num; count ++)
{
sum_temp += data[count];
}
*sum = sum_temp;
}
½6-2 ：函數(shù)的規(guī)模盡量限制在200 行以內(nèi)
說明：不包括注釋和空格行。
½6-3 ：一個(gè)函數(shù)僅完成一件功能
½6-4 ：為簡單功能編寫函數(shù)
說明：雖然為僅用一兩行就可完成的功能去編函數(shù)好象沒有必要，但用函數(shù)可使功能明確化，增加程序可讀性，亦可方便維護(hù)、測試。
示例：如下語句的功能不很明顯。
value = ( a > b ) ? a : b ;
改為如下就很清晰了。
int max (int a, int b)
{
return ((a > b) ? a : b);
}
value = max (a, b);
或改為如下。
#define MAX (a, b) (((a) > (b)) ? (a) : (b))
value = MAX (a, b);
½6-5 ：不要設(shè)計(jì)多用途面面俱到的函數(shù)
說明：多功能集于一身的函數(shù)，很可能使函數(shù)的理解、測試、維護(hù)等變得困難。
½6-6 ：函數(shù)的功能應(yīng)該是可以預(yù)測的，也就是只要輸入數(shù)據(jù)相同就應(yīng)產(chǎn)生同樣的輸出
說明：帶有內(nèi)部“存儲(chǔ)器”的函數(shù)的功能可能是不可預(yù)測的，因?yàn)樗妮敵隹赡苋Q于內(nèi)部存儲(chǔ)器（如某標(biāo)記）的狀態(tài)。這樣的函數(shù)既不易于理解又不利于測試和維護(hù)。在C/C++語言中，函數(shù)的static局部變量是函數(shù)的內(nèi)部存儲(chǔ)器，有可能使函數(shù)的功能不可預(yù)測，然而，當(dāng)某函數(shù)的返回值為指針類型時(shí)，則必須是STATIC的局部變量的地址作為返回值，若為AUTO類，則返回為錯(cuò)針。
示例：如下函數(shù)，其返回值（即功能）是不可預(yù)測的。
unsigned int integer_sum( unsigned int base )
{
unsigned int index;
static unsigned int sum = 0; // 注意，是static類型的。
// 若改為auto類型，則函數(shù)即變?yōu)榭深A(yù)測。
for (index = 1; index <= base; index++)
{
sum += index;
}
return sum;
}
½6-7 ：盡量不要編寫依賴于其他函數(shù)內(nèi)部實(shí)現(xiàn)的函數(shù)
說明：此條為函數(shù)獨(dú)立性的基本要求。由于目前大部分高級語言都是結(jié)構(gòu)化的，所以通過具體語言的語法要求與編譯器功能，基本就可以防止這種情況發(fā)生。但在匯編語言中，由于其靈活性，很可能使函數(shù)出現(xiàn)這種情況。
示例：如下是在DOS下TASM的匯編程序例子。過程Print_Msg的實(shí)現(xiàn)依賴于Input_Msg的具體實(shí)現(xiàn)，這種程序是非結(jié)構(gòu)化的，難以維護(hù)、修改。
... // 程序代碼
proc Print_Msg // 過程（函數(shù)）Print_Msg
... // 程序代碼
jmp LABEL
... // 程序代碼
endp
proc Input_Msg // 過程（函數(shù)）Input_Msg
... // 程序代碼
LABEL:
... // 程序代碼
endp
½6-8 ：避免設(shè)計(jì)多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉
說明：目的減少函數(shù)間接口的復(fù)雜度。
½6-9 ：非調(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)造不太合理。
int add_sub( int a, int b, unsigned char add_sub_flg )
{
if (add_sub_flg == INTEGER_ADD)
{
return (a + b);
}
else
{
return (a b);
}
}
不如分為如下兩個(gè)函數(shù)清晰。
int add( int a, int b )
{
return (a + b);
}
int sub( int a, int b )
{
return (a b);
}
½6-10 ：檢查函數(shù)所有參數(shù)輸入的有效性
½6-11 ：檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等
說明：函數(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)詞（名詞是對象本身）
示例：參照如下方式命名函數(shù)。
void print_record( unsigned int rec_ind ) ;
int input_record( void ) ;
unsigned char get_current_color( void ) ;
建議6-14 ：避免使用無意義或含義不清的動(dòng)詞為函數(shù)命名
說明：避免用含義不清的動(dòng)詞如process、handle等為函數(shù)命名，因?yàn)檫@些動(dòng)詞并沒有說明要具體做什么。
建議6-15 ：函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯(cuò)誤情況
說明：函數(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)換
說明：因?yàn)閿?shù)據(jù)類型轉(zhuǎn)換或多或少存在危險(xiǎn)。
½6-19 ：避免函數(shù)中不必要語句，防止程序中的垃圾代碼
說明：程序中的垃圾代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測試、維護(hù)等造成不必要的麻煩。
½6-20 ：防止把沒有關(guān)聯(lián)的語句放到一個(gè)函數(shù)中
說明：防止函數(shù)或過程內(nèi)出現(xiàn)隨機(jī)內(nèi)聚。隨機(jī)內(nèi)聚是指將沒有關(guān)聯(lián)或關(guān)聯(lián)很弱的語句放到同一個(gè)函數(shù)或過程中。隨機(jī)內(nèi)聚給函數(shù)或過程的維護(hù)、測試及以后的升級等造成了不便，同時(shí)也使函數(shù)或過程的功能不明確。使用隨機(jī)內(nèi)聚函數(shù)，常常容易出現(xiàn)在一種應(yīng)用場合需要改進(jìn)此函數(shù)，而另一種應(yī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)聚。
void Init_Var( void )
{
Rect.length = 0;
Rect.width = 0; /* 初始化矩形的長與寬 */
Point.x = 10;
Point.y = 10; /* 初始化“點(diǎn)”的坐標(biāo) */
}
矩形的長、寬與點(diǎn)的坐標(biāo)基本沒有任何關(guān)系，故以上函數(shù)是隨機(jī)內(nèi)聚。
應(yīng)如下分為兩個(gè)函數(shù)：
void Init_Rect( void )
{
Rect.length = 0;
Rect.width = 0; /* 初始化矩形的長與寬 */
}
void Init_Point( void )
{
Point.x = 10;
Point.y = 10; /* 初始化“點(diǎn)”的坐標(biāo) */
}
½6-21 ：如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題
說明：若此段代碼各語句之間有實(shí)質(zhì)性關(guān)聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構(gòu)造成一個(gè)新的函數(shù)。
½6-22 ：功能不明確較小的函數(shù)，特別是僅有一個(gè)上級函數(shù)調(diào)用它時(shí)，應(yīng)考慮把它合并到上級函數(shù)中，而不必單獨(dú)存在
說明：模塊中函數(shù)劃分的過多，一般會(huì)使函數(shù)間的接口變得復(fù)雜。所以過小的函數(shù)，特別是扇入很低的或功能不明確的函數(shù)，不值得單獨(dú)存在。
½6-23 ：設(shè)計(jì)高扇入、合理扇出（小于7 ）的函數(shù)
說明：扇出是指一個(gè)函數(shù)直接調(diào)用（控制）其它函數(shù)的數(shù)目，而扇入是指有多少上級函數(shù)調(diào)用它。
扇出過大，表明函數(shù)過分復(fù)雜，需要控制和協(xié)調(diào)過多的下級函數(shù)；而扇出過小，如總是1，表明函數(shù)的調(diào)用層次可能過多，這樣不利程序閱讀和函數(shù)結(jié)構(gòu)的分析，并且程序運(yùn)行時(shí)會(huì)對系統(tǒng)資源如堆?？臻g等造成壓力。函數(shù)較合理的扇出（調(diào)度函數(shù)除外）通常是3-5。扇出太大，一般是由于缺乏中間層次，可適當(dāng)增加中間層次的函數(shù)。扇出太小，可把下級函數(shù)進(jìn)一步分解多個(gè)函數(shù)，或合并到上級函數(shù)中。當(dāng)然分解或合并函數(shù)時(shí)，不能改變要實(shí)現(xiàn)的功能，也不能違背函數(shù)間的獨(dú)立性。
扇入越大，表明使用此函數(shù)的上級函數(shù)越多，這樣的函數(shù)使用效率高，但不能違背函數(shù)間的獨(dú)立性而單純地追求高扇入。公共模塊中的函數(shù)及底層函數(shù)應(yīng)該有較高的扇入。
較良好的軟件結(jié)構(gòu)通常是頂層函數(shù)的扇出較高，中層函數(shù)的扇出較少，而底層函數(shù)則扇入到公共模塊中。
½6-24 ：減少函數(shù)本身或函數(shù)間的遞歸調(diào)用
說明：遞歸調(diào)用特別是函數(shù)間的遞歸調(diào)用（如A->B->C->A），影響程序的可理解性；遞歸調(diào)用一般都占用較多的系統(tǒng)資源（如?？臻g）；遞歸調(diào)用對程序的測試有一定影響。故除非為某些算法或功能的實(shí)現(xiàn)方便，應(yīng)減少?zèng)]必要的遞歸調(diào)用。
½6-25 ：仔細(xì)分析模塊的功能及性能需求，并進(jìn)一步細(xì)分，同時(shí)若有必要畫出有關(guān)數(shù)據(jù)流圖，據(jù)此來進(jìn)行模塊的函數(shù)劃分與組織
說明：函數(shù)的劃分與組織是模塊的實(shí)現(xiàn)過程中很關(guān)鍵的步驟，如何劃分出合理的函數(shù)結(jié)構(gòu)，關(guān)系到模塊的最終效率和可維護(hù)性、可測性等。根據(jù)模塊的功能圖或/及數(shù)據(jù)流圖映射出函數(shù)結(jié)構(gòu)是常用方法之一。
½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）通過分解或合并函數(shù)來改進(jìn)軟件結(jié)構(gòu)。
（4）考查函數(shù)的規(guī)模，過大的要進(jìn)行分解。
（5）降低函數(shù)間接口的復(fù)雜度。
（6）不同層次的函數(shù)調(diào)用要有較合理的扇入、扇出。
（7）函數(shù)功能應(yīng)可預(yù)測。
（8）提高函數(shù)內(nèi)聚。（單一功能的函數(shù)內(nèi)聚最高）
說明：對初步劃分后的函數(shù)結(jié)構(gòu)應(yīng)進(jìn)行改進(jìn)、優(yōu)化，使之更為合理。
½6-27 ：在多任務(wù)操作系統(tǒng)的環(huán)境下編程，要注意函數(shù)可重入性的構(gòu)造
說明：可重入性是指函數(shù)可以被多個(gè)任務(wù)進(jìn)程調(diào)用。在多任務(wù)操作系統(tǒng)中，函數(shù)是否具有可重入性是非常重要的，因?yàn)檫@是多個(gè)進(jìn)程可以共用此函數(shù)的必要條件。另外，編譯器是否提供可重入函數(shù)庫，與它所服務(wù)的操作系統(tǒng)有關(guān)，只有操作系統(tǒng)是多任務(wù)時(shí)，編譯器才有可能提供可重入函數(shù)庫。如DOS下BC和MSC等就不具備可重入函數(shù)庫，因?yàn)?span>DOS是單用戶單任務(wù)操作系統(tǒng)。
½6-28 ：避免使用BOOL 參數(shù)
說明：原因有二，其一是BOOL參數(shù)值無意義，TURE/FALSE的含義是非常模糊的，在調(diào)用時(shí)很難知道該參數(shù)到底傳達(dá)的是什么意思；其二是BOOL參數(shù)值不利于擴(kuò)充。還有NULL也是一個(gè)無意義的單詞。
½6-29 ： 對于提供了返回值的函數(shù)，在引用時(shí)最好使用其返回值
½6-30 ：當(dāng)一個(gè)過程（函數(shù)）中對較長變量（一般是結(jié)構(gòu)的成員）有較多引用時(shí)，可以用一個(gè)意義相當(dāng)?shù)暮甏?
說明：這樣可以增加編程效率和程序的可讀性。
示例：在某過程中較多引用TheReceiveBuffer[FirstSocket].byDataPtr，
則可以通過以下宏定義來代替：
# define pSOCKDATA TheReceiveBuffer[FirstScoket].byDataPtr
〔七〕 =====[ 可測性 ]=====
¹7-1 ：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，要有一套統(tǒng)一的為集成測試與系統(tǒng)聯(lián)調(diào)準(zhǔn)備的調(diào)測開關(guān)及相應(yīng)打印函數(shù)，并且要有詳細(xì)的說明
說明：本規(guī)則是針對項(xiàng)目組或產(chǎn)品組的。
¹7-2 ：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，調(diào)測打印出的信息串的格式要有統(tǒng)一的形式。信息串中至少要有所在模塊名（或源文件名）及行號(hào)
說明：統(tǒng)一的調(diào)測信息格式便于集成測試。
¹7-3 ：編程的同時(shí)要為單元測試選擇恰當(dāng)?shù)臏y試點(diǎn)，并仔細(xì)構(gòu)造測試代碼、測試用例，同時(shí)給出明確的注釋說明。測試代碼部分應(yīng)作為（模塊中的）一個(gè)子模塊，以方便測試代碼在模塊中的安裝與拆卸（通過調(diào)測開關(guān)）
說明：為單元測試而準(zhǔn)備。
¹7-4 ：在進(jìn)行集成測試/ 系統(tǒng)聯(lián)調(diào)之前，要構(gòu)造好測試環(huán)境、測試項(xiàng)目及測試用例，同時(shí)仔細(xì)分析并優(yōu)化測試用例，以提高測試效率
說明：好的測試用例應(yīng)盡可能模擬出程序所遇到的邊界值、各種復(fù)雜環(huán)境及一些極端情況等。
¹7-5 ：使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測性
說明：斷言是對某種假設(shè)條件進(jìn)行檢查（可理解為若條件成立則無動(dòng)作，否則應(yīng)報(bào)告），它可以快速發(fā)現(xiàn)并定位軟件問題，同時(shí)對系統(tǒng)錯(cuò)誤進(jìn)行自動(dòng)報(bào)警。斷言可以對在系統(tǒng)中隱藏很深，用其它手段極難發(fā)現(xiàn)的問題進(jìn)行定位，從而縮短軟件問題定位時(shí)間，提高系統(tǒng)的可測性。實(shí)際應(yīng)用時(shí)，可根據(jù)具體情況靈活地設(shè)計(jì)斷言。
示例：下面是C語言中的一個(gè)斷言，用宏來設(shè)計(jì)的。（其中NULL為0L）
#ifdef _EXAM_ASSERT_TEST_ // 若使用斷言測試
void exam_assert( char * file_name, unsigned int line_no )
{
printf( "\n[EXAM]Assert failed: %s, line %u\n",
file_name, line_no );
abort( );
}
#define EXAM_ASSERT( condition )
if (condition) // 若條件成立，則無動(dòng)作
NULL;
else // 否則報(bào)告
exam_assert( __FILE__, __LINE__ )
#else // 若不使用斷言測試
#define EXAM_ASSERT(condition) NULL
#endif /* end of ASSERT */
¹7-6 ：用斷言來檢查程序正常運(yùn)行時(shí)不應(yīng)發(fā)生但在調(diào)測時(shí)有可能發(fā)生的非法情況
¹7-7 ：不能用斷言來檢查最終產(chǎn)品肯定會(huì)出現(xiàn)且必須處理的錯(cuò)誤情況
說明：斷言是用來處理不應(yīng)該發(fā)生的錯(cuò)誤情況的，對于可能會(huì)發(fā)生的且必須處理的情況要寫防錯(cuò)程序，而不是斷言。如某模塊收到其它模塊或鏈路上的消息后，要對消息的合理性進(jìn)行檢查，此過程為正常的錯(cuò)誤檢查，不能用斷言來實(shí)現(xiàn)。
¹7-8 ：對較復(fù)雜的斷言加上明確的注釋
說明：為復(fù)雜的斷言加注釋，可澄清斷言含義并減少不必要的誤用。
¹7-9 ：用斷言確認(rèn)函數(shù)的參數(shù)
示例：假設(shè)某函數(shù)參數(shù)中有一個(gè)指針，那么使用指針前可對它檢查，如下。
int exam_fun( unsigned char *str )
{
EXAM_ASSERT( str != NULL ); // 用斷言檢查“假設(shè)指針不為空”這個(gè)條件
... //other program code
}
¹7-10 ：用斷言保證沒有定義的特性或功能不被使用
示例：假設(shè)某通信模塊在設(shè)計(jì)時(shí)，準(zhǔn)備提供“無連接”和“連接” 這兩種業(yè)務(wù)。但當(dāng)前的版本中僅實(shí)現(xiàn)了“無連接”業(yè)務(wù)，且在此版本的正式發(fā)行版中，用戶（上層模塊）不應(yīng)產(chǎn)生“連接”業(yè)務(wù)的請求，那么在測試時(shí)可用斷言檢查用戶是否使用“連接”業(yè)務(wù)。如下。
#define EXAM_CONNECTIONLESS 0 // 無連接業(yè)務(wù)
#define EXAM_CONNECTION 1 // 連接業(yè)務(wù)
int msg_process( EXAM_MESSAGE *msg )
{
unsigned char service; /* message service class */
EXAM_ASSERT( msg != NULL );
service = get_msg_service_class( msg );
EXAM_ASSERT( service != EXAM_CONNECTION ); // 假設(shè)不使用連接業(yè)務(wù)
... //other program code
}
¹7-11 ：用斷言對程序開發(fā)環(huán)境（OS/Compiler/Hardware ）的假設(shè)進(jìn)行檢查
說明：程序運(yùn)行時(shí)所需的軟硬件環(huán)境及配置要求，不能用斷言來檢查，而必須由一段專門代碼處理。用斷言僅可對程序開發(fā)環(huán)境中的假設(shè)及所配置的某版本軟硬件是否具有某種功能的假設(shè)進(jìn)行檢查。如某網(wǎng)卡是否在系統(tǒng)運(yùn)行環(huán)境中配置了，應(yīng)由程序中正式代碼來檢查；而此網(wǎng)卡是否具有某設(shè)想的功能，則可由斷言來檢查。
對編譯器提供的功能及特性假設(shè)可用斷言檢查，原因是軟件最終產(chǎn)品（即運(yùn)行代碼或機(jī)器碼）與編譯器已沒有任何直接關(guān)系，即軟件運(yùn)行過程中（注意不是編譯過程中）不會(huì)也不應(yīng)該對編譯器的功能提出任何需求。
示例：用斷言檢查編譯器的int型數(shù)據(jù)占用的內(nèi)存空間是否為2，如下。
EXAM_ASSERT( sizeof( int ) == 2 );
¹7-12 ：正式軟件產(chǎn)品中應(yīng)把斷言及其它調(diào)測代碼去掉（即把有關(guān)的調(diào)測開關(guān)關(guān)掉）
說明：加快軟件運(yùn)行速度。
¹7-13 ：在軟件系統(tǒng)中設(shè)置與取消有關(guān)測試手段，不能對軟件實(shí)現(xiàn)的功能等產(chǎn)生影響
說明：即有測試代碼的軟件和關(guān)掉測試代碼的軟件，在功能行為上應(yīng)一致。
¹7-14 ：用調(diào)測開關(guān)來切換軟件的DEBUG 版和正式版，而不要同時(shí)存在正式版本和DEBUG 版本的不同源文件，以減少維護(hù)的難度
¹7-15 ：軟件的DEBUG 版本和發(fā)行版本應(yīng)該統(tǒng)一維護(hù)，不允許分家，并且要時(shí)刻注意保證兩個(gè)版本在實(shí)現(xiàn)功能上的一致性
½7-1 ：在編寫代碼之前，應(yīng)預(yù)先設(shè)計(jì)好程序調(diào)試與測試的方法和手段，并設(shè)計(jì)好各種調(diào)測開關(guān)及相應(yīng)測試代碼如打印函數(shù)等
說明：程序的調(diào)試與測試是軟件生存周期中很重要的一個(gè)階段，如何對軟件進(jìn)行較全面、高率的測試并盡可能地找出軟件中的錯(cuò)誤就成為很關(guān)鍵的問題。因此在編寫源代碼之前，除了要有一套比較完善的測試計(jì)劃外，還應(yīng)設(shè)計(jì)出一系列代碼測試手段，為單元測試、集成測試及系統(tǒng)聯(lián)調(diào)提供方便。
½7-2 ：調(diào)測開關(guān)應(yīng)分為不同級別和類型
說明：調(diào)測開關(guān)的設(shè)置及分類應(yīng)從以下幾方面考慮：針對模塊或系統(tǒng)某部分代碼的調(diào)測；針對模塊或系統(tǒng)某功能的調(diào)測；出于某種其它目的，如對性能、容量等的測試。這樣做便于軟件功能的調(diào)測，并且便于模塊的單元測試、系統(tǒng)聯(lián)調(diào)等。
½7-3 ：編寫防錯(cuò)程序，然后在處理錯(cuò)誤之后可用斷言宣布發(fā)生錯(cuò)誤
示例：假如某模塊收到通信鏈路上的消息，則應(yīng)對消息的合法性進(jìn)行檢查，若消息類別不是通信協(xié)議中規(guī)定的，則應(yīng)進(jìn)行出錯(cuò)處理，之后可用斷言報(bào)告，如下例。
#ifdef _EXAM_ASSERT_TEST_ // 若使用斷言測試
/* Notice: this function does not call 'abort' to exit program */
void assert_report( char * file_name, unsigned int line_no )
{
printf( "\n[EXAM]Error Report: %s, line %u\n",
file_name, line_no );
}
#define ASSERT_REPORT( condition )
if ( condition ) // 若條件成立，則無動(dòng)作
NULL;
else // 否則報(bào)告
assert_report ( __FILE__, __LINE__ )
#else // 若不使用斷言測試
#define ASSERT_REPORT( condition ) NULL
#endif /* end of ASSERT */
int msg_handle( unsigned char msg_name, unsigned char * msg )
{
switch( msg_name )
{
case MSG_ONE:
... // 消息MSG_ONE處理
return MSG_HANDLE_SUCCESS;
... // 其它合法消息處理
default:
... // 消息出錯(cuò)處理
ASSERT_REPORT( FALSE ); // “合法”消息不成立，報(bào)告
return MSG_HANDLE_ERROR;
}
}
〔八〕 =====[ 程序效率 ]=====
¹8-1 ：編程時(shí)要經(jīng)常注意代碼的效率
說明：代碼效率分為全局效率、局部效率、時(shí)間效率及空間效率。全局效率是站在整個(gè)系統(tǒng)的角度上的系統(tǒng)效率；局部效率是站在模塊或函數(shù)角度上的效率；時(shí)間效率是程序處理輸入任務(wù)所需的時(shí)間長短；空間效率是程序所需內(nèi)存空間，如機(jī)器代碼空間大小、數(shù)據(jù)空間大小、?？臻g大小等。
¹8-2 ：在保證軟件系統(tǒng)的正確性、穩(wěn)定性、可讀性及可測性的前提下，提高代碼效率
說明：不能一味地追求代碼效率，而對軟件的正確性、穩(wěn)定性、可讀性及可測性造成影響。
¹8-3 ：局部效率應(yīng)為全局效率服務(wù)，不能因?yàn)樘岣呔植啃识鴮θ中试斐捎绊?
¹8-4 ：通過對系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進(jìn)，以及對程序算法的優(yōu)化來提高空間效率
說明：這種方式是解決軟件空間效率的根本辦法。
示例：如下記錄學(xué)生學(xué)習(xí)成績的結(jié)構(gòu)不合理。
typedef unsigned char BYTE;
typedef unsigned short WORD;
typedef struct STUDENT_SCORE_STRU
BYTE name[8];
BYTE age;
BYTE sex;
BYTE class;
BYTE subject;
float score;
} STUDENT_SCORE;
因?yàn)槊课粚W(xué)生都有多科學(xué)習(xí)成績，故如上結(jié)構(gòu)將占用較大空間。應(yīng)如下改進(jìn)（分為兩個(gè)結(jié)構(gòu)），總的存貯空間將變小，操作也變得更方便。
typedef struct STUDENT_STRU
{
BYTE name[8];
BYTE age;
BYTE sex;
BYTE class;
} STUDENT;
typedef struct STUDENT_SCORE_STRU
{
WORD student_index;
BYTE subject;
float score;
} STUDENT_SCORE;
¹8-5 ：循環(huán)體內(nèi)工作量最小化
說明：應(yīng)仔細(xì)考慮循環(huán)體內(nèi)的語句是否可以放在循環(huán)體之外，使循環(huán)體內(nèi)工作量最小，從而提高程序的時(shí)間效率。
示例：如下代碼效率不高。
for (ind = 0; ind < MAX_ADD_NUMBER; ind++)
{
sum += ind;
back_sum = sum; /* backup sum */
}
語句“back_sum = sum;”完全可以放在for語句之后，如下。
for (ind = 0; ind < MAX_ADD_NUMBER; ind++)
{
sum += ind;
}
back_sum = sum; /* backup sum */
½8-1 ：仔細(xì)分析有關(guān)算法，并進(jìn)行優(yōu)化
½8-2 ：仔細(xì)考查、分析系統(tǒng)及模塊處理輸入（如事務(wù)、消息等）的方式，并加以改進(jìn)
½8-3 ：對模塊中函數(shù)的劃分及組織方式進(jìn)行分析、優(yōu)化，改進(jìn)模塊中函數(shù)的組織結(jié)構(gòu)，提高程序效率
說明：軟件系統(tǒng)的效率主要與算法、處理任務(wù)方式、系統(tǒng)功能及函數(shù)結(jié)構(gòu)有很大關(guān)系，僅在代碼上下功夫一般不能解決根本問題。
½8-4 ：編程時(shí)，要隨時(shí)留心代碼效率；優(yōu)化代碼時(shí)，要考慮周全
½8-5 ：不應(yīng)花過多的時(shí)間拼命地提高調(diào)用不很頻繁的函數(shù)代碼效率
說明：對代碼優(yōu)化可提高效率，但若考慮不周很有可能引起嚴(yán)重后果。
½8-6 ：要仔細(xì)地構(gòu)造或直接用匯編編寫調(diào)用頻繁或性能要求極高的函數(shù)
說明：只有對編譯系統(tǒng)產(chǎn)生機(jī)器碼的方式以及硬件系統(tǒng)較為熟悉時(shí)，才可使用匯編嵌入方式。嵌入?yún)R編可提高時(shí)間及空間效率，但也存在一定風(fēng)險(xiǎn)。
½8-7 ：在保證程序質(zhì)量的前提下，通過壓縮代碼量、去掉不必要代碼以及減少不必要的局部和全局變量，來提高空間效率
說明：這種方式對提高空間效率可起到一定作用，但往往不能解決根本問題。
½8-8 ：在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層
說明：減少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];
}
}
½8-9 ：盡量減少循環(huán)嵌套層次
½8-10 ：避免循環(huán)體內(nèi)含判斷語句，應(yīng)將循環(huán)語句置于判斷語句的代碼塊之中
說明：目的是減少判斷次數(shù)。循環(huán)體中的判斷語句是否可以移到循環(huán)體外，要視程序的具體情況而言，一般情況，與循環(huán)變量無關(guān)的判斷語句可以移到循環(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句與循環(huán)變量無關(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;
}
}
½8-11 ：盡量用乘法或其它方法代替除法，特別是浮點(diǎn)運(yùn)算中的除法
說明：浮點(diǎn)運(yùn)算除法要占用較多CPU資源。
示例：如下表達(dá)式運(yùn)算可能要占較多CPU資源。
#define PAI 3.1416
radius = circle_length / (2 * PAI);
應(yīng)如下把浮點(diǎn)除法改為浮點(diǎn)乘法。
#define PAI_RECIPROCAL (1 / 3.1416 ) // 編譯器編譯時(shí)，將生成具體浮點(diǎn)數(shù)
radius = circle_length * PAI_RECIPROCAL / 2;
½8-12 ：不要一味追求緊湊的代碼
說明：因?yàn)榫o湊的代碼并不代表高效的機(jī)器碼。
〔九〕 =====[ 質(zhì)量保證 ]=====
¹9-1 ：在軟件設(shè)計(jì)過程中構(gòu)筑軟件質(zhì)量
¹9-2 ：代碼質(zhì)量保證優(yōu)先原則
（1）正確性，指程序要實(shí)現(xiàn)設(shè)計(jì)要求的功能。
（2）穩(wěn)定性、安全性，指程序穩(wěn)定、可靠、安全。
（3）可測試性，指程序要具有良好的可測試性。
（4）規(guī)范/可讀性，指程序書寫風(fēng)格、命名規(guī)則等要符合規(guī)范。
（5）全局效率，指軟件系統(tǒng)的整體效率。
（6）局部效率，指某個(gè)模塊/子模塊/函數(shù)的本身效率。
（7）個(gè)人表達(dá)方式/個(gè)人方便性，指個(gè)人編程習(xí)慣。
¹9-3 ：只引用屬于自己的存貯空間
說明：若模塊封裝的較好，那么一般不會(huì)發(fā)生非法引用他人的空間。
¹9-4 ：防止引用已經(jīng)釋放的內(nèi)存空間
說明：在實(shí)際編程過程中，稍不留心就會(huì)出現(xiàn)在一個(gè)模塊中釋放了某個(gè)內(nèi)存塊（如C語言指針），而另一模塊在隨后的某個(gè)時(shí)刻又使用了它。要防止這種情況發(fā)生。
¹9-5 ：過程/ 函數(shù)中分配的內(nèi)存，在過程/ 函數(shù)退出之前要釋放
¹9-6 ：過程/ 函數(shù)中申請的（為打開文件而使用的）文件句柄，在過程/ 函數(shù)退出之前要關(guān)閉
說明：分配的內(nèi)存不釋放以及文件句柄不關(guān)閉，是較常見的錯(cuò)誤，而且稍不注意就有可能發(fā)生。這類錯(cuò)誤往往會(huì)引起很嚴(yán)重后果，且難以定位。
示例：下函數(shù)在退出之前，沒有把分配的內(nèi)存釋放。
typedef unsigned char BYTE;
int example_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)改為如下。
int example_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
}
¹9-7 ：防止內(nèi)存操作越界
說明：內(nèi)存操作主要是指對數(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，那么如下程序存在問題。
#define MAX_USR_NUM 10
unsigned char usr_login_flg[MAX_USR_NUM]= "";
void set_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。
void set_usr_login_flg( unsigned char usr_no )
{
if (!usr_login_flg[usr_no - 1])
{
usr_login_flg[usr_no - 1]= TRUE;
}
}
¹9-8 ：認(rèn)真處理程序所能遇到的各種出錯(cuò)情況
¹9-9 ：系統(tǒng)運(yùn)行之初，要初始化有關(guān)變量及運(yùn)行環(huán)境，防止未經(jīng)初始化的變量被引用
¹9-10 ：系統(tǒng)運(yùn)行之初，要對加載到系統(tǒng)中的數(shù)據(jù)進(jìn)行一致性檢查
說明：使用不一致的數(shù)據(jù)，容易使系統(tǒng)進(jìn)入混亂狀態(tài)和不可知狀態(tài)。
¹9-11 ：嚴(yán)禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置
說明：編程時(shí)，不能隨心所欲地更改不屬于自己模塊的有關(guān)設(shè)置如常量、數(shù)組的大小等。
¹9-12 ：不能隨意改變與其它模塊的接口
¹9-13 ：充分了解系統(tǒng)的接口之后，再使用系統(tǒng)提供的功能
示例：在B型機(jī)的各模塊與操作系統(tǒng)的接口函數(shù)中，有一個(gè)要由各模塊負(fù)責(zé)編寫的初始化過程，此過程在軟件系統(tǒng)加載完成后，由操作系統(tǒng)發(fā)送的初始化消息來調(diào)度。因此就涉及到初始化消息的類型與消息發(fā)送的順序問題，特別是消息順序，若沒搞清楚就開始編程，很容易引起嚴(yán)重后果。以下示例引自B型曾出現(xiàn)過的實(shí)際代碼，其中使用了FID_FETCH_DATA與FID_INITIAL初始化消息類型，注意B型機(jī)的系統(tǒng)是在FID_FETCH_DATA之前發(fā)送FID_INITIAL的。
MID alarm_module_list[MAX_ALARM_MID];
int FAR SYS_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中（**）之前；要么就必須考慮（**）處的判斷語句是否可以用（不使用alarm_module_list變量的）其它方式替代，或者是否可以取消此判斷語句。
¹9-14 ：編程時(shí)，要防止差1 錯(cuò)誤
說明：此類錯(cuò)誤一般是由于把“<=”誤寫成“<”或“>=”誤寫成“>”等造成的，由此引起的后果，很多情況下是很嚴(yán)重的，所以編程時(shí)，一定要在這些地方小心。當(dāng)編完程序后，應(yīng)對這些操作符進(jìn)行徹底檢查。
¹9-15 ：要時(shí)刻注意易混淆的操作符。當(dāng)編完程序后，應(yīng)從頭至尾檢查一遍這些操作符，以防止拼寫錯(cuò)誤
說明：形式相近的操作符最容易引起誤用，如C/C++中的“=”與“==”、“|”與“||”、“&”與“&&”等，若拼寫錯(cuò)了，編譯器不一定能夠檢查出來。
示例：如把“&”寫成“&&”，或反之。
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 ));
¹9-16 ：有可能的話，if 語句盡量加上else 分支，對沒有else 分支的語句要小心對待；switch 語句必須有default 分支
¹9-17 ：Unix 下，多線程的中的子線程退出必需采用主動(dòng)退出方式，即子線程應(yīng)return 出口。
¹9-18 ：不要濫用goto 語句。
說明：goto語句會(huì)破壞程序的結(jié)構(gòu)性，所以除非確實(shí)需要，最好不使用goto語句。
½9-1 ：不使用與硬件或操作系統(tǒng)關(guān)系很大的語句，而使用建議的標(biāo)準(zhǔn)語句，以提高軟件的可移植性和可重用性
½9-2 ：除非為了滿足特殊需求，避免使用嵌入式匯編
說明：程序中嵌入式匯編，一般都對可移植性有較大的影響。
½9-3 ：精心地構(gòu)造、劃分子模塊，并按“ 接口” 部分及“ 內(nèi)核” 部分合理地組織子模塊，以提高“ 內(nèi)核” 部分的可移植性和可重用性
說明：對不同產(chǎn)品中的某個(gè)功能相同的模塊，若能做到其內(nèi)核部分完全或基本一致，那么無論對產(chǎn)品的測試、維護(hù)，還是對以后產(chǎn)品的升級都會(huì)有很大幫助。
½9-4 ：精心構(gòu)造算法，并對其性能、效率進(jìn)行測試
½9-5 ：對較關(guān)鍵的算法最好使用其它算法來確認(rèn)
½9-6 ：時(shí)刻注意表達(dá)式是否會(huì)上溢、下溢
示例：如下程序?qū)⒃斐勺兞肯乱纭?
unsigned char 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
}
½9-7 ：使用變量時(shí)要注意其邊界值的情況
示例：如C語言中字符型變量，有效值范圍為-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;
½9-8 ：留心程序機(jī)器碼大?。ㄈ缰噶羁臻g大小、數(shù)據(jù)空間大小、堆?？臻g大小等）是否超出系統(tǒng)有關(guān)限制
½9-9 ：為用戶提供良好的接口界面，使用戶能較充分地了解系統(tǒng)內(nèi)部運(yùn)行狀態(tài)及有關(guān)系統(tǒng)出錯(cuò)情況
½9-10 ：系統(tǒng)應(yīng)具有一定的容錯(cuò)能力，對一些錯(cuò)誤事件（如用戶誤操作等）能進(jìn)行自動(dòng)補(bǔ)救
½9-11 ：對一些具有危險(xiǎn)性的操作代碼（如寫硬盤、刪數(shù)據(jù)等）要仔細(xì)考慮，防止對數(shù)據(jù)、硬件等的安全構(gòu)成危害，以提高系統(tǒng)的安全性
½9-12 ：使用第三方提供的軟件開發(fā)工具包或控件時(shí)，要注意以下幾點(diǎn)：
（1）充分了解應(yīng)用接口、使用環(huán)境及使用時(shí)注意事項(xiàng)。
（2）不能過分相信其正確性。
（3）除非必要，不要使用不熟悉的第三方工具包與控件。
說明：使用工具包與控件，可加快程序開發(fā)速度，節(jié)省時(shí)間，但使用之前一定對它有較充分的了解，同時(shí)第三方工具包與控件也有可能存在問題。
½9-13 ：資源文件（多語言版本支持），如果資源是對語言敏感的，應(yīng)讓該資源與源代碼文件脫離，具體方法有下面幾種：使用單獨(dú)的資源文件、DLL 文件或其它單獨(dú)的描述文件（如數(shù)據(jù)庫格式）
〔十〕 =====[ 代碼編輯、編譯、審查 ]=====
¹10-1 ：打開編譯器的所有告警開關(guān)對程序進(jìn)行編譯
¹10-2 ：在產(chǎn)品軟件（項(xiàng)目組）中，要統(tǒng)一編譯開關(guān)選項(xiàng)
¹10-3 ：通過代碼走讀及審查方式對代碼進(jìn)行檢查
說明：代碼走讀主要是對程序的編程風(fēng)格如注釋、命名等以及編程時(shí)易出錯(cuò)的內(nèi)容進(jìn)行檢查，可由開發(fā)人員自己或開發(fā)人員交叉的方式進(jìn)行；代碼審查主要是對程序?qū)崿F(xiàn)的功能及程序的穩(wěn)定性、安全性、可靠性等進(jìn)行檢查及評審，可通過自審、交叉審核或指定部門抽查等方式進(jìn)行。
¹10-4 ：測試部測試產(chǎn)品之前，應(yīng)對代碼進(jìn)行抽查及評審
½10-1 ：編寫代碼時(shí)要注意隨時(shí)保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼丟失
½10-2 ：同產(chǎn)品軟件（項(xiàng)目組）內(nèi)，最好使用相同的編輯器，并使用相同的設(shè)置選項(xiàng)
說明：同一項(xiàng)目組最好采用相同的智能語言編輯器，如Muiti Editor，Visual Editor等，并設(shè)計(jì)、使用一套縮進(jìn)宏及注釋宏等，將縮進(jìn)等問題交由編輯器處理。
½10-3 ：要小心地使用編輯器提供的塊拷貝功能編程
說明：當(dāng)某段代碼與另一段代碼的處理功能相似時(shí)，許多開發(fā)人員都用編輯器提供的塊拷貝功能來完成這段代碼的編寫。由于程序功能相近，故所使用的變量、采用的表達(dá)式等在功能及命名上可能都很相近，所以使用塊拷貝時(shí)要注意，除了修改相應(yīng)的程序外，一定要把使用的每個(gè)變量仔細(xì)查看一遍，以改成正確的。不應(yīng)指望編譯器能查出所有這種錯(cuò)誤，比如當(dāng)使用的是全局變量時(shí)，就有可能使某種錯(cuò)誤隱藏下來。
½10-4 ：合理地設(shè)計(jì)軟件系統(tǒng)目錄，方便開發(fā)人員使用
說明：方便、合理的軟件系統(tǒng)目錄，可提高工作效率。目錄構(gòu)造的原則是方便有關(guān)源程序的存儲(chǔ)、查詢、編譯、鏈接等工作，同時(shí)目錄中還應(yīng)具有工作目錄----所有的編譯、鏈接等工作應(yīng)在此目錄中進(jìn)行，工具目錄----有關(guān)文件編輯器、文件查找等工具可存放在此目錄中。
½10-5 ：某些語句經(jīng)編譯后產(chǎn)生告警，但如果你認(rèn)為它是正確的，那么應(yīng)通過某種手段去掉告警信息
說明：在Borland C/C++中，可用“#pragma warn”來關(guān)掉或打開某些告警。
示例：
#pragma warn -rvl // 關(guān)閉告警
int examples_fun( void )
{
// 程序，但無return語句。
}
#pragma warn +rvl // 打開告警
編譯函數(shù)examples_fun時(shí)本應(yīng)產(chǎn)生“函數(shù)應(yīng)有返回值”告警，但由于關(guān)掉了此告警信息顯示，所以編譯時(shí)將不會(huì)產(chǎn)生此告警提示。
½10-6 ：使用代碼檢查工具（如C 語言用PC-Lint ）對源程序檢查
½10-7 ：使用軟件工具（如 LogiSCOPE ）進(jìn)行代碼審查
〔十一〕 =====[ 代碼測試、維護(hù) ]=====
¹11-1 ：單元測試要求至少達(dá)到語句覆蓋
¹11-2 ：單元測試開始要跟蹤每一條語句，并觀察數(shù)據(jù)流及變量的變化
¹11-3 ：清理、整理或優(yōu)化后的代碼要經(jīng)過審查及測試
¹11-4 ：代碼版本升級要經(jīng)過嚴(yán)格測試
¹11-5 ：使用工具軟件對代碼版本進(jìn)行維護(hù)
¹11-6 ：正式版本上軟件的任何修改都應(yīng)有詳細(xì)的文檔記錄
½11-1 ：發(fā)現(xiàn)錯(cuò)誤立即修改，并且要記錄下來
½11-2 ：關(guān)鍵的代碼在匯編級跟蹤
½11-3 ：仔細(xì)設(shè)計(jì)并分析測試用例，使測試用例覆蓋盡可能多的情況，以提高測試用例的效率
½11-4 ：盡可能模擬出程序的各種出錯(cuò)情況，對出錯(cuò)處理代碼進(jìn)行充分的測試
½11-5 ：仔細(xì)測試代碼處理數(shù)據(jù)、變量的邊界情況
½11-6 ：保留測試信息，以便分析、總結(jié)經(jīng)驗(yàn)及進(jìn)行更充分的測試
½11-7 ：不應(yīng)通過“ 試” 來解決問題，應(yīng)尋找問題的根本原因
½11-8 ：對自動(dòng)消失的錯(cuò)誤進(jìn)行分析，搞清楚錯(cuò)誤是如何消失的
½11-9 ：修改錯(cuò)誤不僅要治表，更要治本
½11-10 ：測試時(shí)應(yīng)設(shè)法使很少發(fā)生的事件經(jīng)常發(fā)生
½11-11 ：明確模塊或函數(shù)處理哪些事件，并使它們經(jīng)常發(fā)生
½11-12 ： 堅(jiān)持在編碼階段就對代碼進(jìn)行徹底的單元測試，不要等以后的測試工作來發(fā)現(xiàn)問題
½11-13：去除代碼運(yùn)行的隨機(jī)性（如去掉無用的數(shù)據(jù)、代碼及盡可能防止并注意函數(shù)中的“內(nèi)部寄存器”等），讓函數(shù)運(yùn)行的結(jié)果可預(yù)測，并使出現(xiàn)的錯(cuò)誤可再現(xiàn)
〔十二〕 =====[ 宏 ]=====
¹12-1 ：用宏定義表達(dá)式時(shí)，要使用完備的括號(hào)
示例：如下定義的宏都存在一定的風(fēng)險(xiǎn)。
#define RECTANGLE_AREA( a, b ) a * b
#define RECTANGLE_AREA( a, b ) (a * b)
#define RECTANGLE_AREA( a, b ) (a) * (b)
正確的定義應(yīng)為：
#define RECTANGLE_AREA( a, b ) ((a) * (b))
¹12-2: 將宏所定義的多條表達(dá)式放在大括號(hào)中
示例：下面的語句只有宏的第一條表達(dá)式被執(zhí)行。為了說明問題，for語句的書寫稍不符規(guī)范。
#define INTI_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)為：
#define INTI_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 );
}
¹12-3: 使用宏時(shí)，不允許參數(shù)發(fā)生變化
示例：如下用法可能導(dǎo)致錯(cuò)誤。
#define SQUARE( 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。
============================= End =================================