c++程序設(shè)計規(guī)范

1、ANSIANSI C/C+C/C+程序設(shè)計規(guī)范程序設(shè)計規(guī)范 文件編號： SDSI-QG-28- 01-01 起草部門： 審 核 人： 批 準(zhǔn) 人： 批準(zhǔn)日期：2008 年 4 月 版本標(biāo)識： 1.0 版 目目錄錄 1目的目的.3 2定義定義.3 3程序設(shè)計要求程序設(shè)計要求.3 4程序風(fēng)格定義程序風(fēng)格定義.4 4.1編程風(fēng)格.4 4.1.1書寫風(fēng)格.4 4.1.2程序結(jié)構(gòu).4 4.1.3程序注釋.5 4.1.4聲明.6 4.1.5臨時變量.6 4.2一些規(guī)則及建議：.6 5命名規(guī)范命名規(guī)范.6 5.1詳細(xì)定義.7 5.1.1函數(shù)（Function）.7 5.1.2變量命名規(guī)范.7 5.1.3常用

2、變量的規(guī)定：.8 5.2類定義規(guī)范.8 5.2.1類的命名.8 5.2.2類的注釋.8 5.2.3類的聲明.9 1 目的目的 為使整個系統(tǒng)保持統(tǒng)一和一致的編程風(fēng)格及技術(shù)，提高程序代碼的規(guī)范化 程度，制定該部分的規(guī)范。這些規(guī)范可以提高編碼質(zhì)量、增強(qiáng)可讀性、提高排 錯的容易程度、加強(qiáng)可維護(hù)性、以及提高代碼的可重用性和可移植性。 1.1 定義定義 程序塊：是整個 C/C+語言程序中完成某一細(xì)分功能的具有相對獨(dú)立性的一 段程序，其主要內(nèi)容包括注釋、變量定義及程序正文三部分組成。 子程序塊：程序塊中的某一細(xì)分功能的程序塊稱為子程序塊。 臨時變量：臨時變量是每次賦值的作用域較小，一般不應(yīng)超過五行程序。 臨

3、時變量的名字本身只是說明了該變量是一個臨時的操作數(shù)，不具有任何意義， 但在某一作用域內(nèi)代表不同的具體含義。 2 程序設(shè)計要求程序設(shè)計要求 一、據(jù)所確定的標(biāo)準(zhǔn)進(jìn)行程序設(shè)計。 二、模塊內(nèi)的耦合度要高，模塊間的耦合度要低。在修改一個模塊時，盡量不 要對其它模塊造成影響，若影響較大，有必要重新規(guī)劃模塊。 三、每個程序模塊的行數(shù)不限，但對于程序模塊中相對獨(dú)立性較高的程序塊最 好作成函數(shù)，每個函數(shù)的代碼行數(shù)原則上不超過 200 行，經(jīng)常使用的函數(shù)最好經(jīng)常使用的函數(shù)最好 做成函數(shù)庫，必須保證在整個系統(tǒng)中同名的函數(shù)有相同的定義。做成函數(shù)庫，必須保證在整個系統(tǒng)中同名的函數(shù)有相同的定義。 四、盡量為程序塊加上明確

4、的漢語注釋。對于較復(fù)雜的程序或算法需要注釋文 檔，并在程序中注明注釋文檔及在文檔中注明程序名。 3 開發(fā)規(guī)范開發(fā)規(guī)范 3.1 風(fēng)格規(guī)范風(fēng)格規(guī)范 3.1.1 縮進(jìn)風(fēng)格縮進(jìn)風(fēng)格 3.1.1.1概述概述 縮進(jìn)用于提高代碼的可閱讀性，縮進(jìn)通常采用 TAB 鍵來控制縮進(jìn)風(fēng)格，但為了不同 TAB 值的問題，縮進(jìn)采用空格縮進(jìn)。在 UE 中，通常將 TAB 設(shè)置成為 2 個空格。 3.1.1.2要求描述要求描述 程序采用縮進(jìn)風(fēng)格，在需要縮進(jìn)的地方使用 2 個空格個空格進(jìn)行縮進(jìn)。 函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格， case 語句下的情況處理語句也要遵從語句縮進(jìn)要求。 3.

5、1.1.3示例示例 無 3.1.2 代碼塊分隔代碼塊分隔 3.1.2.1概述概述 相對獨(dú)立的短代碼、變量定義需要分隔開，在讀代碼時可以方便的區(qū)分出獨(dú)立代碼。 3.1.2.2要求描述要求描述 在代碼之間、變量定義之后使用一行空行一行空行來分隔代碼，用于區(qū)分代碼。 3.1.2.3示例示例 if (!valid_ni(ni) . /* program code*/ repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; 3.1.3 長語句分隔長語句分隔 3.1.3.1概述概述 通常情況下屏幕長度可以容納超過 80

6、例字符，但為適應(yīng)多種屏幕（如 VI） ，且一行過 長大多數(shù)人心理無法承受，所以長語句要分隔。大多數(shù)情況下建議單行代碼長度不要 超過 80 個字符，通常情況下可以使用各種方法縮減單行代碼。 3.1.3.2要求描述要求描述 較長的語句（80 字符）要分成多行書寫分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行， 操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。 3.1.3.3示例示例 單條語句單條語句: perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _

7、UL ); act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied = stat_poiindex.occupied; act_task_tabletaskno.duration_true_or_false = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = (taskno MAX_ACT_TASK_NUMBER) 循環(huán)、判斷類循環(huán)、判斷類: if (taskno max_act_task_number) (i BufferKeywordwo

8、rd_index.word_length) i+, j+) . /* program code*/ for (i = 0, j = 0; (i first_word_length) (2)比較操作符, 賦值操作符=、 +=，算術(shù)操作符+、%，邏輯操作符 a *= 2; a = b 2; (3)!、+、-、 /* 內(nèi)容操作*與內(nèi)容之間*/ flag = !isEmpty; /* 非操作!與內(nèi)容之間*/ p = /* 地址操作 /* +,-與內(nèi)容之間*/ (4)-、.前后不加空格。 p-id = pid; /* -指針前后不加空格*/ (5) if、for、while、switch 等與后面的括號

9、間應(yīng)加空格，使 if 等關(guān)鍵字更為 突出、明顯。 if (a = b 3.2.6 注釋位置注釋位置 3.2.6.1概述概述 注釋要清晰的表明注釋的是那塊代碼，而不得采用非常規(guī)的注釋需要進(jìn)行分析才知道 注釋的那塊代碼。 3.2.6.2要求描述要求描述 注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋） 相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。 除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。 3.2.6.3示例示例 /*打開動態(tài)鏈接庫*/ pLib = dlopen(LIBBILLSO, RTLD_LAZY); 3.2.7 變

10、量常量注釋變量常量注釋 3.2.7.1概述概述 變量常量注釋用于閱讀者可以清晰的知道此變量的用途。 3.2.7.2要求描述要求描述 對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須 加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。 數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須 加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每 個域的注釋放在此域的右方。 全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及 存取時注意事項等的說明。 3.2.7.3示例示例 #def

11、ineALLOW_UNDEAL0/ 不允許處理 /*模塊調(diào)用執(zhí)行存儲過程結(jié)構(gòu)體*/ typedef struct _Proc_Exec int64proc_id;/模塊標(biāo)識 har ex_sql_name20;/執(zhí)行名稱 T_Proc_Exec; 3.2.8 注釋縮進(jìn)注釋縮進(jìn) 3.2.8.1概述概述 注釋縮進(jìn)采用與注釋的代碼相同規(guī)則。 3.2.8.2要求描述要求描述 注釋與所描述內(nèi)容進(jìn)行同樣的縮排。 3.2.8.3示例示例 void example_fun( void ) /* 注釋 1 */ CodeBlock One /* 注釋 2*/ CodeBlock Two 3.2.9 注釋與空行注

12、釋與空行 3.2.9.1概述概述 為美觀注釋上要有空行。 3.2.9.2要求描述要求描述 將注釋與其上面的代碼用空行隔開。 3.2.9.3示例示例 /* 代碼一注釋 */ program code one /* 代碼二注釋 */ program code two 3.2.10跳轉(zhuǎn)注釋跳轉(zhuǎn)注釋 3.2.10.1 概述概述 跳轉(zhuǎn)語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護(hù)人員來說，良好的注釋幫助 更好的理解程序，有時甚至優(yōu)于看設(shè)計文檔。 。 3.2.10.2 要求描述要求描述 對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。 對于 switch 語句下的 case 語句，如果因為特殊

13、情況需要處理完一個 case 后進(jìn)入下一個 case 處理，必須在該 case 語句處理完、下一個 case 語句前加上明確的注釋。 3.2.10.3 示例示例 case CMD_UP: /* 注釋內(nèi)容 */ ProcessUp(); break; 3.2.11注釋語言注釋語言 3.2.11.1 概述概述 注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護(hù)人員的考慮，建議使用中 文，除非標(biāo)準(zhǔn)英語注釋 3.2.11.2 要求描述要求描述 標(biāo)準(zhǔn)英語或中文，盡量用中文。 3.2.11.3 示例示例 無 3.3 標(biāo)識符規(guī)范標(biāo)識符規(guī)范 3.3.1 清晰明了清晰明了 3.3.1.1概述概述 標(biāo)識符的命名

14、要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解 的縮寫，避免使人產(chǎn)生誤解。 3.3.1.2要求描述要求描述 較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮 寫；一些單詞有大家公認(rèn)的縮寫。 對于變量命名，禁止取單個字符（如 i、j、k.） ，建議除了要有具體含義外，還能表明 其變量類型、數(shù)據(jù)類型等，但 i、j、k 作局部循環(huán)變量是允許的。 3.3.1.3示例示例 temp 可縮寫為 tmp ; flag 可縮寫為 flg ; statistic 可縮寫為 stat ; increment 可縮寫為 inc ; message 可縮寫為 msg ; 3.

15、3.2 風(fēng)格風(fēng)格 3.3.2.1概述概述 命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項目中統(tǒng)一。 3.3.2.2要求描述要求描述 采用 UNIX 的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線 混排的方式，用作特殊標(biāo)識如標(biāo)識成員變量或全局變量的 m_和 g_，其后加上大小寫 混排的方式是允許的。 除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識符。 3.3.2.3示例示例 錯誤風(fēng)格：錯誤風(fēng)格： #define _EXAMPLE_0_TEST_ #define _EXAMPLE_1_TEST_ void set_sls00( BYTE sls ); 正確風(fēng)格：正確風(fēng)格： #d

16、efine _EXAMPLE_UNIT_TEST_ #define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls ); 3.4 過程規(guī)范過程規(guī)范 3.4.1 返回值返回值 3.4.1.1概述概述 對于函數(shù)的返回值要進(jìn)行全面的判斷，由于返回值判斷不周可能會導(dǎo)致程序出錯但沒 有正確的報告。 3.4.1.2要求描述要求描述 對所調(diào)用函數(shù)的錯誤返回碼要仔細(xì)、全面地處理。 3.4.1.3示例示例 無 3.4.2 過程長度過程長度 3.4.2.1概述概述 一個函數(shù)的代碼行是沒有限制的，但為了容易閱讀代碼長度應(yīng)限制在兩屏可觀的程度， 通常情況下代碼

17、行不應(yīng)超過行。 3.4.2.2要求描述要求描述 代碼長度不超過行。 3.4.2.3示例示例 無 3.4.3 一個功能一個函數(shù)一個功能一個函數(shù) 3.4.3.1概述概述 一個函數(shù)可以完成很多功能，但大多數(shù)情況下，一個函數(shù)只完成一個功能。一般通過 它做什么的句式來驗證函數(shù)是否是有效的。如果需要它做什么和什么，通常不是個好 函數(shù)。 在比如 MAX 算法，通常情況下一個？：語句就可以實現(xiàn)，但用函數(shù)來實現(xiàn)在后續(xù)的維 護(hù)中可以更好的進(jìn)行升級。 還有一種比較極端的情況是，一個函數(shù)實現(xiàn)了過多的功能，此函數(shù)通常不易理解。 3.4.3.2要求描述要求描述 一個函數(shù)僅完成一件功能。 3.4.3.3示例示例 錯誤例子：

18、錯誤例子： 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); 3.5 可讀性規(guī)范可讀性規(guī)范 3.5.1 運(yùn)算符優(yōu)先級運(yùn)算符優(yōu)先級 3.5.1.1概述概述 注意運(yùn)算符的優(yōu)先級，并用括號明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級。 3.5.1.2要求描述要求描述 防止閱讀程序時產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級與設(shè)計思想不

19、符而導(dǎo)致程序出錯。 3.5.1.3示例示例 word = (high 8) | low (1) if (a | b) . / program code 優(yōu)秀的例子：優(yōu)秀的例子： #define TRUNK_IDLE 0 #define TRUNK_BUSY 1 if (Trunkindex.trunk_state = TRUNK_IDLE) Trunkindex.trunk_state = TRUNK_BUSY; . / program code 3.5.3 關(guān)系緊密緊湊關(guān)系緊密緊湊 3.5.3.1概述概述 在代碼中關(guān)系聯(lián)系比較緊湊的代碼盡量寫在一起方便閱讀者閱讀程序。 3.5.3.2要求描述

20、要求描述 源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。 3.5.3.3示例示例 錯誤的例子：錯誤的例子： rect.length = 10; char_poi = str; rect.width = 5; 優(yōu)秀的例子：優(yōu)秀的例子： rect.length = 10; rect.width = 5; / 矩形的長與寬關(guān)系較密切，放在一起。 char_poi = str; 3.5.4 高技巧高技巧!=高可讀高可讀 3.5.4.1概述概述 程序可以寫的非常復(fù)雜，但技巧性高的代碼并不一定是高效率的，效率一般從代碼的 算法來考慮，不要考慮從匯編角度考慮問題。 3.5.4.2要求描述要求描述 高技巧語句不等于

21、高效率的程序，實際上程序的效率關(guān)鍵在于算法。 3.5.4.3示例示例 錯誤的例子：錯誤的例子： * stat_poi + += 1; * + stat_poi += 1; 優(yōu)秀的例子：優(yōu)秀的例子： *stat_poi += 1; stat_poi+; / 此二語句功能相當(dāng)于“ * stat_poi + += 1; ” + stat_poi; *stat_poi += 1; / 此二語句功能相當(dāng)于“ * + stat_poi += 1; ” 3.6 變量規(guī)范變量規(guī)范 3.6.1 慎用全局變量慎用全局變量 3.6.1.1概述概述 全局變量通常是萬惡之源，如非確實必要禁止使用全局變量。 3.6.1.

22、2要求描述要求描述 如需使用全局變量須向項目負(fù)責(zé)人書面申請，且在全局變量做詳細(xì)注釋，表明此全局 變量的用途，使用的函數(shù)，函數(shù)間的交互。 3.6.1.3示例示例 無。 3.6.2 變量初始化變量初始化 3.6.2.1概述概述 變量不初始化就使用通常會產(chǎn)生不可預(yù)料的后果。 3.6.2.2要求描述要求描述 每個變量都需要進(jìn)行初始化特別是指針變量。 3.6.2.3示例示例 無。 3.6.3 變量定義變量定義 3.6.3.1概述概述 變量的定義和主機(jī)、編譯器有比較大的關(guān)系，部分變量類型在部分系統(tǒng)上是不支持的， 尤其要考慮位主機(jī)和位主機(jī)的關(guān)系。 3.6.3.2要求描述要求描述 變量只使用三種 INT32_

23、T,INT64_T,CHAR_T，且不要使用特別奇怪的變量前綴，比如 register 等，慎用 static 類型。 INT32_T,INT64_T,CHAR_T 的定義在系統(tǒng)的頭文件中定義，根據(jù)不同的主機(jī)不同的編 譯器使用不同的實際定義。 3.6.3.3示例示例 #define INT32 int #define INT64 long/*位主機(jī)*/ #define INT64 long long/*32 位主機(jī)*/ 3.6.4 結(jié)構(gòu)定義結(jié)構(gòu)定義 3.6.4.1概述概述 設(shè)計結(jié)構(gòu)時應(yīng)力爭使結(jié)構(gòu)代表一種現(xiàn)實事務(wù)的抽象，而不是同時代表多種。結(jié)構(gòu)中的 各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒

24、有關(guān)系或關(guān)系很弱的不同事務(wù)的 元素放到同一結(jié)構(gòu)中。 3.6.4.2要求描述要求描述 結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象，而不是一個大雜燴。 面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。 3.6.4.3示例示例 錯誤例子：錯誤例子： typedef struct STUDENT_STRU unsigned char name8; /* students name */ unsigned char age; /* students age */ unsigned char sex; /* students sex, as follows */ /* 0 - FEMALE; 1 - MA

25、LE */ unsigned char teacher_name8; /* the student teachers name */ unisgned char teacher_sex; /* his teacher sex */ STUDENT; 正確例子：正確例子： typedef struct TEACHER_STRU unsigned char name8; /* teacher name */ unisgned char sex; /* teacher sex, as follows */ /* 0 - FEMALE; 1 - MALE */ TEACHER; typedef str

26、uct STUDENT_STRU unsigned char name8; /* students name */ unsigned char age; /* students age */ unsigned char sex; /* students sex, as follows */ /* 0 - FEMALE; 1 - MALE */ unsigned int teacher_ind; /* his teacher index */ STUDENT; 錯誤例子：錯誤例子： typedef struct PERSON_ONE_STRU unsigned char name8; unsig

27、ned char addr40; unsigned char sex; unsigned char city15; PERSON_ONE; typedef struct PERSON_TWO_STRU unsigned char name8; unsigned char age; unsigned char tel; PERSON_TWO; 正確例子：正確例子： typedef struct PERSON_STRU unsigned char name8; unsigned char age; unsigned char sex; unsigned char addr40; unsigned

28、char city15; unsigned char tel; PERSON; 3.6.5 結(jié)構(gòu)成員個數(shù)結(jié)構(gòu)成員個數(shù) 3.6.5.1概述概述 一個結(jié)構(gòu)體通常不要使用太多的成員，除非必要。 3.6.5.2要求描述要求描述 結(jié)構(gòu)中元素的個數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個數(shù)過多可考慮依據(jù)某種原則把元素組成不 同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個數(shù) 3.6.5.3示例示例 3.6.6 字節(jié)順序字節(jié)順序 3.6.6.1概述概述 3.6.6.2要求描述要求描述 當(dāng)聲明用于分布式環(huán)境或不同 CPU 間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時，必須考慮機(jī)器的字節(jié)順 序、使用的位域及字節(jié)對齊等問題 。 3.6.6.3示例示例 比如 Inte

29、l CPU 與 68360 CPU，在處理位域及整數(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é)為單位） e

30、xam 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)一個 long 型數(shù)（如圖中 long1）在內(nèi)存中的位置正好與內(nèi)存的字 邊界對齊時，CPU 存取這個數(shù)只需訪問一次內(nèi)存，而當(dāng)一

31、個 long 型數(shù)（如圖中的 long2）在內(nèi)存中的位置跨越了字邊界時，CPU 存取這個數(shù)就需要多次訪問內(nèi)存，如 i960cx 訪問這樣的數(shù)需讀內(nèi)存三次（一個 BYTE、一個 SHORT、一個 BYTE，由 CPU 的微代碼執(zhí)行，對軟件透明） ，所有對齊方式下 CPU 的運(yùn)行效率明顯快多了。 1 8 16 24 32 - - - - | long1 | long1 | long1 | long1 | - - - - | | | | long2 | - - - - | long2 | long2 | long2 | | - - - - 3.7 測試性規(guī)范測試性規(guī)范 3.7.1 調(diào)測調(diào)測 3.7.

32、1.1概述概述 3.7.1.2要求描述要求描述 在同一項目組或產(chǎn)品組內(nèi)，要有一套統(tǒng)一的為集成測試與系統(tǒng)聯(lián)調(diào)準(zhǔn)備的調(diào)測開關(guān)及 相應(yīng)打印函數(shù)，并且要有詳細(xì)的說明。調(diào)測打印出的信息串的格式要有統(tǒng)一的形式。 信息串中至少要有所在模塊名（或源文件名）及行號。 編程的同時要為單元測試選擇恰當(dāng)?shù)臏y試點(diǎn)，并仔細(xì)構(gòu)造測試代碼、測試用例，同時 給出明確的注釋說明。測試代碼部分應(yīng)作為（模塊中的）一個子模塊，以方便測試代 碼在模塊中的安裝與拆卸（通過調(diào)測開關(guān)） 。 在軟件系統(tǒng)中設(shè)置與取消有關(guān)測試手段，不能對軟件實現(xiàn)的功能等產(chǎn)生影響。 用調(diào)測開關(guān)來切換軟件的 DEBUG 版和正式版，而不要同時存在正式版本和 DEBUG

33、 版本的不同源文件，以減少維護(hù)的難度。 軟件的 DEBUG 版本和發(fā)行版本應(yīng)該統(tǒng)一維護(hù)，不允許分家，并且要時刻注意保證兩 個版本在實現(xiàn)功能上的一致性。 在編寫代碼之前，應(yīng)預(yù)先設(shè)計好程序調(diào)試與測試的方法和手段，并設(shè)計好各種調(diào)測開 關(guān)及相應(yīng)測試代碼如打印函數(shù)等。 編寫防錯程序，然后在處理錯誤之后可用斷言宣布發(fā)生錯誤。 3.7.1.3示例示例 示例：假如某模塊收到通信鏈路上的消息，則應(yīng)對消息的合法性進(jìn)行檢查，若消息類 別不是通信協(xié)議中規(guī)定的，則應(yīng)進(jìn)行出錯處理，之后可用斷言報告，如下例。 #ifdef _EXAM_ASSERT_TEST_ / 若使用斷言測試 /* Notice: this funct

34、ion does not call abort to exit program */ void assert_report( char * file_name, unsigned int line_no ) printf( nEXAMError Report: %s, line %un, file_name, line_no ); #define ASSERT_REPORT( condition ) if ( condition ) / 若條件成立，則無動作 NULL; else / 否則報告 assert_report ( _FILE_, _LINE_ ) #else / 若不使用斷言測試

35、#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: . / 消息出錯處理 ASSERT_REPORT( FALSE ); / “合法”消息不成立，報告 return MSG_HANDLE_ERR

36、OR; 3.7.2 斷言斷言 3.7.2.1概述概述 斷言是對某種假設(shè)條件進(jìn)行檢查（可理解為若條件成立則無動作，否則應(yīng)報告） ，它可 以快速發(fā)現(xiàn)并定位軟件問題，同時對系統(tǒng)錯誤進(jìn)行自動報警。斷言可以對在系統(tǒng)中隱藏很 深，用其它手段極難發(fā)現(xiàn)的問題進(jìn)行定位，從而縮短軟件問題定位時間，提高系統(tǒng)的可測 性。實際應(yīng)用時，可根據(jù)具體情況靈活地設(shè)計斷言。 斷言是用來處理不應(yīng)該發(fā)生的錯誤情況的，對于可能會發(fā)生的且必須處理的情況要寫 防錯程序，而不是斷言。如某模塊收到其它模塊或鏈路上的消息后，要對消息的合理性進(jìn) 行檢查，此過程為正常的錯誤檢查，不能用斷言來實現(xiàn)。 程序運(yùn)行時所需的軟硬件環(huán)境及配置要求，不能用斷言來

37、檢查，而必須由一段專門代 碼處理。用斷言僅可對程序開發(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)行過程中（注意不是編譯過程中）不會 也不應(yīng)該對編譯器的功能提出任何需求。 3.7.2.2要求描述要求描述 使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測性。 用斷言來檢查程序正常運(yùn)行時不應(yīng)發(fā)生但在調(diào)測時有可能發(fā)生的非法情況。 不能用斷言來檢查最終產(chǎn)品肯定

38、會出現(xiàn)且必須處理的錯誤情況。 用斷言確認(rèn)函數(shù)的參數(shù)。 對較復(fù)雜的斷言加上明確的注釋。 用斷言保證沒有定義的特性或功能不被使用。 用斷言對程序開發(fā)環(huán)境（OS/Compiler/Hardware）的假設(shè)進(jìn)行檢查。 正式軟件產(chǎn)品中應(yīng)把斷言及其它調(diào)測代碼去掉（即把有關(guān)的調(diào)測開關(guān)關(guān)掉） 。 3.7.2.3示例示例 #ifdef _EXAM_ASSERT_TEST_ / 若使用斷言測試 void exam_assert( char * file_name, unsigned int line_no ) printf( nEXAMAssert failed: %s, line %un, file_name,

39、 line_no ); abort( ); #define EXAM_ASSERT( condition ) if (condition) / 若條件成立，則無動作 NULL; else / 否則報告 exam_assert( _FILE_, _LINE_ ) #else / 若不使用斷言測試 #define EXAM_ASSERT(condition) NULL #endif /* end of ASSERT */ 3.8 效率規(guī)范效率規(guī)范 3.8.1 寫代碼時即注意效率寫代碼時即注意效率 3.8.1.1概述概述 代碼效率分為全局效率、局部效率、時間效率及空間效率。全局效率是站在整個系統(tǒng) 的

40、角度上的系統(tǒng)效率；局部效率是站在模塊或函數(shù)角度上的效率；時間效率是程序處 理輸入任務(wù)所需的時間長短；空間效率是程序所需內(nèi)存空間，如機(jī)器代碼空間大小、 數(shù)據(jù)空間大小、棧空間大小等。 3.8.1.2要求描述要求描述 編程時要經(jīng)常注意代碼的效率，但要在保證軟件系統(tǒng)的正確性、穩(wěn)定性、可讀性及可 測性的前提下，提高代碼效率。局部效率應(yīng)為全局效率服務(wù)，不能因為提高局部效率 而對全局效率造成影響。 3.8.1.3示例示例 無 3.8.2 空間效率空間效率 3.8.2.1概述概述 大部分情況下空間占用都是個主要的問題，在系統(tǒng)內(nèi)存有限的情況下，如何縮減內(nèi)存 占用都是問題，比如內(nèi)存是 10G，但每個進(jìn)程的空間占用

41、 1G，則表明并發(fā)處理只能啟 動 10 個進(jìn)程。 3.8.2.2要求描述要求描述 通過對系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進(jìn)，以及對程序算法的優(yōu)化來提高空間效率。 人為的縮減變量可用值是不可取的，比如電話號碼最長可以是位，但通常情況下 是位或者位，為了縮減這部分空間把電話號碼的長度改為位，是不可取的， 而是通過結(jié)構(gòu)的調(diào)整來縮減空間占用，當(dāng)然動態(tài)的內(nèi)存占用分配會減少空間占用，但 存在的問題是效率會降低，且后期維護(hù)代碼復(fù)雜。 3.8.2.3示例示例 如下記錄學(xué)生學(xué)習(xí)成績的結(jié)構(gòu)不合理。 typedef unsigned char BYTE; typedef unsigned short WORD; typ

42、edef struct STUDENT_SCORE_STRU BYTE name8; BYTE age; BYTE sex; BYTE class; BYTE subject; float score; STUDENT_SCORE; 因為每位學(xué)生都有多科學(xué)習(xí)成績，故如上結(jié)構(gòu)將占用較大空間。應(yīng)如下改進(jìn)（分為兩 個結(jié)構(gòu)） ，總的存貯空間將變小，操作也變得更方便。 typedef struct STUDENT_STRU BYTE name8; BYTE age; BYTE sex; BYTE class; STUDENT; typedef struct STUDENT_SCORE_STRU WORD

43、 student_index; BYTE subject; float score; STUDENT_SCORE; 3.8.3 時間效率時間效率 3.8.3.1概述概述 時間效率的關(guān)鍵之處在于減少計算量，減少計算量大體有兩個思路，：通過調(diào)整代 碼結(jié)構(gòu)縮減計算量，這種方法在大多數(shù)情況是有效的，但提高性能比率可能不會很高。 ：通過調(diào)整算法縮減計算量。 3.8.3.2要求描述要求描述 通過改進(jìn)算法提高效率。 優(yōu)化最關(guān)鍵的的應(yīng)用代碼。 優(yōu)化最占時間的關(guān)鍵代碼。 謹(jǐn)慎使用匯編代碼，大多數(shù)情況下是沒有必要使用匯編代碼，如需使用需與項目負(fù)責(zé) 人申請。 對輸入輸出部分要仔細(xì)考慮，通常在此會有效率的瓶頸。 3.

44、8.3.3示例示例 無。 3.8.4 多重循環(huán)多重循環(huán) 3.8.4.1概述概述 時間效率的關(guān)鍵之處在于減少計算量，減少計算量大體有兩個思路，：通過調(diào)整代 碼結(jié)構(gòu)縮減計算量，這種方法在大多數(shù)情況是有效的，但提高性能比率可能不會很高。 ：通過調(diào)整算法縮減計算量。 3.8.4.2要求描述要求描述 在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層。且盡量減少循環(huán)嵌套層次。最忙的循環(huán)放在最內(nèi)層。且盡量減少循環(huán)嵌套層次。 3.8.4.3示例示例 下面示例并不合理，但確是優(yōu)化的一個思路。 如下代碼效率不高。 for (row = 0; row 100; row+) If(arowcol)continue; for (

45、col = 0; col 5; col+) sum += arowcol; 可以改為如下方式，以提高效率。 for (col = 0; col 5; col+) If(arowcol)continue; for (row = 0; row 100; row+) sum += arowcol; 3.8.5 結(jié)構(gòu)調(diào)整結(jié)構(gòu)調(diào)整 3.8.5.1概述概述 3.8.5.2要求描述要求描述 避免循環(huán)體內(nèi)含判斷語句，應(yīng)將循環(huán)語句置于判斷語句的代碼塊之中。 3.8.5.3示例示例 如下代碼效率稍低。 for (ind = 0; ind MAX_RECT_NUMBER; ind+) if (data_type =

46、 RECT_AREA) area_sum += rect_areaind; else rect_length_sum += rectind.length; rect_width_sum += rectind.width; 因為判斷語句與循環(huán)變量無關(guān)，故可如下改進(jìn)，以減少判斷次數(shù)。 if (data_type = RECT_AREA) for (ind = 0; ind MAX_RECT_NUMBER; ind+) area_sum += rect_areaind; else for (ind = 0; ind MAX_RECT_NUMBER; ind+) rect_length_sum +=

47、rectind.length; rect_width_sum += rectind.width; 3.8.6 常量預(yù)先計算常量預(yù)先計算 3.8.6.1概述概述 3.8.6.2要求描述要求描述 對于長使用的計算常量可以預(yù)先定義常量計算出來。 3.8.6.3示例示例 #define PAI 3.1416 radius = circle_length / (2 * PAI); 應(yīng)如下把浮點(diǎn)除法改為浮點(diǎn)乘法。 #define PAI_RECIPROCAL (1 / 3.1416 ) / 編譯器編譯時，將生成具體浮 點(diǎn)數(shù) radius = circle_length * PAI_RECIPROCAL /

48、 2; 3.8.7 避免數(shù)據(jù)庫交互避免數(shù)據(jù)庫交互 3.8.7.1概述概述 3.8.7.2要求描述要求描述 盡量避免頻繁的與數(shù)據(jù)庫交互，通常數(shù)據(jù)庫交互每秒不會超過 10000 次，每次計算都 與數(shù)據(jù)庫交互則會使計算效率低于 10000 次/秒。 通常的解決辦法是使用緩存或者使用共享內(nèi)存的方式降低數(shù)據(jù)庫交互。比如序列號的 獲取采用每 100000 次獲取一次。批價資料存放到共享內(nèi)存中，資料更新采用單獨(dú)更新 進(jìn)程。 另一種辦法是把數(shù)據(jù)庫交互部分做成一個單獨(dú)的進(jìn)程，主進(jìn)程不直接與數(shù)據(jù)庫交互， 此方法通常用于非關(guān)鍵是計算，比如日志輸出到數(shù)據(jù)庫，其它需要輸入到數(shù)據(jù)庫的內(nèi) 容。 3.8.7.3示例示例 無

49、3.9 質(zhì)量規(guī)范質(zhì)量規(guī)范 3.9.1 質(zhì)量優(yōu)先質(zhì)量優(yōu)先 3.9.1.1概述概述 3.9.1.2要求描述要求描述 代碼質(zhì)量保證優(yōu)先原則代碼質(zhì)量保證優(yōu)先原則 （1）正確性，指程序要實現(xiàn)設(shè)計要求的功能。 （2）穩(wěn)定性、安全性，指程序穩(wěn)定、可靠、安全。 （3）可測試性，指程序要具有良好的可測試性。 （4）規(guī)范/可讀性，指程序書寫風(fēng)格、命名規(guī)則等要符合規(guī)范。 （5）全局效率，指軟件系統(tǒng)的整體效率。 （6）局部效率，指某個模塊/子模塊/函數(shù)的本身效率。 （7）個人表達(dá)方式/個人方便性，指個人編程習(xí)慣。 3.9.1.3示例示例 無 3.9.2 資源使用資源使用 3.9.2.1概述概述 3.9.2.2要求描述

50、要求描述 只引用屬于自己的存貯空間。 防止引用已經(jīng)釋放的內(nèi)存空間。 過程/函數(shù)中分配的內(nèi)存，在過程/函數(shù)退出之前要釋放。 過程/函數(shù)中申請的（為打開文件而使用的）文件句柄，在過程/函數(shù)退出之前要關(guān)閉。 防止內(nèi)存操作越界。 3.9.2.3示例示例 無 3.9.3 邊界問題邊界問題 3.9.3.1概述概述 3.9.3.2要求描述要求描述 編程時，要防止差 1 錯誤。此類錯誤一般是由于把“=”誤寫成“=”誤寫 成“”等造成的，由此引起的后果，很多情況下是很嚴(yán)重的，所以編程時，一定要 在這些地方小心。當(dāng)編完程序后，應(yīng)對這些操作符進(jìn)行徹底檢查。 使用變量時要注意其邊界值的情況。 時刻注意表達(dá)式是否會上溢、下溢。 3.9.3.3示例示例 如下程序?qū)⒃斐勺兞肯乱纭?unsigned