【導(dǎo)讀】〔三〕=====[標(biāo)識(shí)符命名]=======.〔四〕=====[可讀性]======.〔五〕=====[變量、結(jié)構(gòu)]=====.〔六〕=====[函數(shù)、過程]=====.〔七〕=====[可測(cè)性]=====.〔十〕=====[代碼編輯、編譯、審查]=====.〔十一〕=====[代碼測(cè)試、維護(hù)]=====.¹1-3：較長(zhǎng)的語句要分成多行書寫，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放。¹1-4：循環(huán)、判斷等語句中若有較長(zhǎng)的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操。¹1-7：if、for、do、while、case、switch、default等語句自占一行，且if、for、do、while. ¹1-10：程序塊的分界符（如C/C++語言的大括號(hào)?）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引。用它們的語句左對(duì)齊。¹1-11：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加?？崭?；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－>），后不應(yīng)加空格。語言中括號(hào)已經(jīng)是最清晰的標(biāo)志了。

　　

【正文】 能使函數(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 189。68：避免設(shè)計(jì)多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉 說明：目的減少函數(shù)間接口的復(fù) 雜度。 189。69：非調(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)。 } 189。610：檢查函數(shù)所有參數(shù)輸入的有效性 189。611：檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等 說明：函數(shù)的輸入主要有兩種：一種是參數(shù)輸入；另一種是全局變量、數(shù)據(jù)文件的輸入，即非參數(shù)輸入。函數(shù)在使用輸入之前，應(yīng)進(jìn)行必要的檢查。 189。612：函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能 189。613：使用動(dòng)賓詞組為執(zhí)行某操作的函數(shù)命名。如果是 OOP方法，可以只有動(dòng)詞（名詞是對(duì)象本身） 示例：參照如下方式命名函數(shù)。 void print_record( unsigned int rec_ind ) 。 int input_record( void ) 。 unsigned char get_current_color( void ) 。 建議 614：避免使用無意義或含義不清的動(dòng)詞為函數(shù)命名 說明：避免用含義不清的動(dòng)詞如 process、 handle等為函數(shù)命名，因?yàn)檫@些動(dòng)詞并沒有說明要具體做什么。 建議 615：函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯(cuò)誤情況 說明：函數(shù)的每種出錯(cuò)返回值的意義要清晰、明了、準(zhǔn)確，防止使用者誤用、理解錯(cuò)誤或忽視錯(cuò)誤返回碼。 189。616：除非必要，最好不要把與函數(shù)返回值類型不同的變量，以編譯系統(tǒng)默認(rèn)的轉(zhuǎn)換方式或強(qiáng)制的轉(zhuǎn)換方 式作為返回值返回 189。617：讓函數(shù)在調(diào)用點(diǎn)顯得易懂、容易理解 189。618：在調(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)。 189。619：避免函數(shù)中不必要語句，防止程序中的垃圾代碼 說明：程序中的垃圾代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測(cè)試、維護(hù)等造成不必要的麻煩。 189。620：防止把沒有關(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ù)、測(cè)試及以后的升級(jí)等造成了不便，同時(shí)也使函數(shù)或過程的功能不明確。使用隨機(jī)內(nèi)聚函數(shù)，常常容易出現(xiàn)在一種應(yīng)用場(chǎng)合需要改進(jìn)此函數(shù)，而另一種應(yīng)用場(chǎng)合又不允許這種改進(jìn)，從而陷入困境。 在編程時(shí)，經(jīng)常遇到在不同函數(shù)中使用相同的代碼，許多開發(fā)人員都愿把這些代碼提出來，并構(gòu)成一個(gè)新函數(shù)。若這些代碼關(guān)聯(lián)較大并且是完成一個(gè)功能的，那么這種構(gòu)造是合理的，否則這種構(gòu)造將產(chǎn)生隨機(jī)內(nèi)聚的函數(shù)。 示例：如下函數(shù)就是一種隨機(jī)內(nèi)聚。 void Init_Var( void ) { = 0。 = 0。 /* 初始化矩形的長(zhǎng)與寬 */ = 10。 = 10。 /* 初始化 “點(diǎn) ”的坐標(biāo) */ } 矩形的長(zhǎng)、寬與點(diǎn)的坐標(biāo)基本沒有任何關(guān)系，故以上函數(shù)是隨機(jī)內(nèi)聚。 應(yīng)如下分為兩個(gè)函數(shù)： void Init_Rect( void ) { = 0。 = 0。 /* 初始化矩形的長(zhǎng)與寬 */ } void Init_Point( void ) { = 10。 = 10。 /* 初始化 “點(diǎn) ”的坐標(biāo) */ } 189。621：如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題 說明：若此段代碼各語句之間有實(shí)質(zhì)性關(guān)聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構(gòu)造成一個(gè)新的函數(shù)。 189。622：功能不明確較小的函數(shù)，特別是僅有一個(gè)上級(jí)函數(shù)調(diào)用它時(shí)，應(yīng)考慮把它合并到上級(jí)函數(shù)中，而不必單獨(dú)存在 說明：模塊中函數(shù)劃分的過多，一般會(huì)使函數(shù)間的接口變得復(fù)雜。所以過小的函數(shù)，特別是扇入很低的或功能不明確的函數(shù)，不值得單獨(dú) 存在。 189。623：設(shè)計(jì)高扇入、合理扇出（小于 7）的函數(shù) 說明：扇出是指一個(gè)函數(shù)直接調(diào)用（控制）其它函數(shù)的數(shù)目，而扇入是指有多少上級(jí)函數(shù)調(diào)用它。 扇出過大，表明函數(shù)過分復(fù)雜，需要控制和協(xié)調(diào)過多的下級(jí)函數(shù)；而扇出過小，如總是 1，表明函數(shù)的調(diào)用層次可能過多，這樣不利程序閱讀和函數(shù)結(jié)構(gòu)的分析，并且程序運(yùn)行時(shí)會(huì)對(duì)系統(tǒng)資源如堆?？臻g等造成壓力。函數(shù)較合理的扇出（調(diào)度函數(shù)除外）通常是 35。扇出太大，一般是由于缺乏中間層次，可適當(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ù)則扇入到公共模塊中。 189。624：減少函數(shù)本身或函數(shù)間的遞歸調(diào)用 說明：遞歸調(diào)用特別是函數(shù)間的遞歸調(diào)用（如 ABCA），影響程序的可理解性；遞歸調(diào)用一般都占用較多的系統(tǒng)資源（如棧空間）；遞歸調(diào)用對(duì)程序的測(cè)試有一定影 響。故除非為某些算法或功能的實(shí)現(xiàn)方便，應(yīng)減少?zèng)]必要的遞歸調(diào)用。 189。625：仔細(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ù)性、可測(cè)性等。根據(jù)模塊的功能圖或 /及數(shù)據(jù)流圖映射出函數(shù)結(jié)構(gòu)是常用方法之一。 189。626：改進(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ù)測(cè)。 （ 8）提高函數(shù)內(nèi)聚。（單一功能的函數(shù)內(nèi)聚最高） 說明：對(duì)初步劃分后的函數(shù)結(jié)構(gòu)應(yīng)進(jìn)行改進(jìn)、優(yōu)化，使之更為合理。 189。627：在多任務(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)?DOS是單用戶單任務(wù)操作系統(tǒng)。 189。628：避免使用 BOOL參數(shù) 說明：原因有二，其一是 BOOL參數(shù)值無意義， TURE/FALSE的含義是非常模糊的，在調(diào)用時(shí)很難知道該參數(shù)到底傳達(dá)的是什么意思；其二是 BOOL參數(shù)值不利于擴(kuò)充。還有 NULL也是一個(gè)無意義的單詞。 189。629：對(duì)于提供了返回值的函數(shù)，在引用時(shí)最好使用其返回值 189。630：當(dāng)一個(gè)過程（函數(shù)）中對(duì)較長(zhǎng)變量（一般是結(jié)構(gòu)的成員）有較多引用時(shí)，可以用一個(gè)意義相當(dāng)?shù)暮甏? 說明：這樣可以增加編程效率和程序的可讀性。 示例：在某過程中較多引用 TheReceiveBuffer[FirstSocket].byDataPtr， 則可以通過以下宏定義來代替： define pSOCKDATA TheReceiveBuffer[FirstScoket].byDataPtr 〔七〕 =====[ 可測(cè)性 ]===== 185。7 1：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，要有一套統(tǒng)一的為集成測(cè)試與系統(tǒng)聯(lián)調(diào)準(zhǔn)備的調(diào)測(cè)開關(guān)及相應(yīng)打印函數(shù)，并且要有詳細(xì)的說明 說明：本規(guī)則是針對(duì)項(xiàng)目組或產(chǎn)品組的。 185。7 2：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，調(diào)測(cè)打印出的信息串的格式要有統(tǒng)一的形式。信息串中至少要有所在模塊名（或源文件名）及行號(hào) 說明：統(tǒng)一的調(diào)測(cè)信息格式便于集成測(cè)試。 185。7 3：編程的同時(shí)要為單元測(cè)試選擇恰當(dāng)?shù)臏y(cè)試點(diǎn)，并仔細(xì)構(gòu)造測(cè)試代碼、測(cè)試用例，同時(shí)給出明確的注釋說明。測(cè)試代碼部分應(yīng)作為（模塊中的）一個(gè)子模塊，以方便測(cè)試代碼在模塊中的安裝與拆卸（通過調(diào)測(cè)開關(guān) ） 說明：為單元測(cè)試而準(zhǔn)備。 185。7 4：在進(jìn)行集成測(cè)試 /系統(tǒng)聯(lián)調(diào)之前，要構(gòu)造好測(cè)試環(huán)境、測(cè)試項(xiàng)目及測(cè)試用例，同時(shí)仔細(xì)分析并優(yōu)化測(cè)試用例，以提高測(cè)試效率 說明：好的測(cè)試用例應(yīng)盡可能模擬出程序所遇到的邊界值、各種復(fù)雜環(huán)境及一些極端情況等。 185。7 5：使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測(cè)性 說明：斷言是對(duì)某種假設(shè)條件進(jìn)行檢查（可理解為若條件成立則無動(dòng)作，否則應(yīng)報(bào)告），它可以快速發(fā)現(xiàn)并定位軟件問題，同時(shí)對(duì)系統(tǒng)錯(cuò)誤進(jìn)行自動(dòng)報(bào)警。斷言可以對(duì)在系統(tǒng)中隱藏很深，用其它手段極難發(fā)現(xiàn)的問題進(jìn)行定位，從而縮短軟件問題定位時(shí)間，提 高系統(tǒng)的可測(cè)性。實(shí)際應(yīng)用時(shí)，可根據(jù)具體情況靈活地設(shè)計(jì)斷言。 示例：下面是 C 語言中的一個(gè)斷言，用宏來設(shè)計(jì)的。（其中 NULL為 0L） ifdef _EXAM_ASSERT_TEST_ // 若使用斷言測(cè)試 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 // 若不使用斷言測(cè)試 define EXAM_ASSERT(condition) NULL endif /* end of ASSERT */ 185。7 6：用斷言來檢查程序正常運(yùn)行 時(shí)不應(yīng)發(fā)生但在調(diào)測(cè)時(shí)有可能發(fā)生的非法情況 185。7 7：不能用斷言來檢查最終產(chǎn)品肯定會(huì)出現(xiàn)且必須處理的錯(cuò)誤情況 說明：斷言是用來處理不應(yīng)該發(fā)生的錯(cuò)誤情況的，對(duì)于可能會(huì)發(fā)生的且必須處理的情況要寫防錯(cuò)程序，而不是斷言。如某模塊收到其它模塊或鏈路上的消息后，要對(duì)消息的合理性進(jìn)行檢查，此過程為正常的錯(cuò)誤檢查，不能用斷言來實(shí)現(xiàn)。 185。7 8：對(duì)較復(fù)雜的斷言加上明確的注釋 說明：為復(fù)雜的斷言加注釋，可澄清斷言含義并減少不必要的誤用。 185。7 9：用斷言確認(rèn)函數(shù)的參數(shù) 示例：假設(shè)某函數(shù)參數(shù)中有一個(gè)指針，那么使用指針前可對(duì)它檢查， 如下。 int exam_fun( unsigned char *str ) { EXAM_ASSERT( str != NULL )。 // 用斷言檢查 “假設(shè)指針不為空 ”這個(gè)條件 ... //other program code } 185。7 10：用斷言保證沒有定義的特性或功能不被使用 示例：假設(shè)某通信模塊在設(shè)計(jì)時(shí)，準(zhǔn)備提供 “無連接 ”和 “連接 ”這兩種業(yè)務(wù)。但當(dāng)前的版本中僅實(shí)現(xiàn)了 “無連接 ”業(yè)務(wù)，且在此版本的正式發(fā)行版中，用戶（上層模塊