【正文】 : 目 錄 1 排版 6 2 注釋 11 3 標(biāo)識(shí)符命名 18 4 可讀性 20 5 變量、結(jié)構(gòu) 22 6 函數(shù)、過(guò)程 28 7 可測(cè)性 36 8 程序效率 40 9 質(zhì)量保證 44 10 代碼編輯、編譯、審查 50 11 代碼測(cè)試、維護(hù) 52 12 宏 53 軟件編程規(guī)范總則 1 排版 僅供內(nèi)部使用 3 1 排版 185。11：程序塊要采用縮進(jìn)風(fēng)格編寫(xiě)，縮進(jìn)的空格數(shù)為 4個(gè)。 說(shuō)明：對(duì)于由開(kāi)發(fā)工具自動(dòng)生成的代碼可以有不一致。 185。12：相對(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)如下書(shū)寫(xiě) if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index。 repssn_ni = ssn_data[index].ni。 185。13：較長(zhǎng) 的語(yǔ)句（ 80字符）要分成多行書(shū)寫(xiě)，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀。 示例： = 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) 軟件編程規(guī)范總則 1 排版 僅供內(nèi)部使用 4 amp。amp。 (n7stat_stat_item_valid (stat_item)) amp。amp。 (act_task_table[taskno].result_data != 0))。 軟件編程規(guī)范總則 1 排版 僅供內(nèi)部使用 5 185。14：循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。 示例： if ((taskno max_act_task_number) amp。amp。 (n7stat_stat_item_valid (stat_item))) { ... // program code } for (i = 0, j = 0。 (i BufferKeyword[word_index].word_length) amp。amp。 (j )。 i++, j++) { ... // program code } for (i = 0, j = 0。 (i first_word_length) amp。amp。 (j second_word_length)。 i++, j++) { ... // program code } 185。15：若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧? 示例： n7stat_str_pare((BYTE *) amp。 stat_object, (BYTE *) amp。 (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT))。 n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object )。 185。16：不允許把多個(gè)短語(yǔ)句寫(xiě)在一行中，即一行只寫(xiě)一條語(yǔ)句。 示例：如下例子不符合規(guī)范。 = 0。 = 0。 應(yīng)如下書(shū)寫(xiě) 軟件編程規(guī)范總則 1 排版 僅供內(nèi)部使用 6 = 0。 = 0。 185。17： 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)如下書(shū)寫(xiě)： if (pUserCR == NULL) { return。 } 185。18：對(duì)齊只使用空格鍵，不使用 TAB鍵。 說(shuō)明：以免用不同的編輯器閱讀程序時(shí)，因 TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊 ， 不要使用 BC作為編輯器合版本，因?yàn)?BC會(huì)自動(dòng)將 8個(gè)空格變?yōu)橐粋€(gè) TAB鍵，因此使用 BC合入的版本大多會(huì)將縮進(jìn)變亂。 185。19：函數(shù)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格， case語(yǔ)句下的情況處理語(yǔ)句也要遵從語(yǔ)句縮進(jìn)要求。 185。110：程序塊的分界符（如 C/C++語(yǔ)言的大括號(hào)‘ {’和‘ }’ ）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。在函數(shù)體的開(kāi)始、類(lèi)的定義、結(jié)構(gòu)的定義、枚舉的定義以及 if、 for、 do、 while、 switch、 case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。 示例：如下例子不符合規(guī)范。 for (...) { ... // program code } if (...) { ... // program code } 軟件編程規(guī)范總則 1 排版 僅供內(nèi)部使用 7 void example_fun( void ) { ... // program code } 應(yīng)如下書(shū)寫(xiě)。 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } 185。111：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－ ），后不應(yīng)加空格。 說(shuō)明：采用這種松散方式編寫(xiě)代碼的目的是使代碼更加 清晰。 由于留空格所產(chǎn)生的清晰性是相對(duì)的，所以，在已經(jīng)非常清晰的語(yǔ)句中沒(méi)有必要再留空格，如果語(yǔ)句已足夠清晰則括號(hào)內(nèi)側(cè) (即左括號(hào)后面和右括號(hào)前面 )不需要加空格，多重括號(hào)間不必加空格，因?yàn)樵?C/C++語(yǔ)言中括號(hào)已經(jīng)是最清晰的標(biāo)志了。 在長(zhǎng)語(yǔ)句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。 示例： (1) 逗號(hào)、分號(hào)只在后面加空格。 int a, b, c。 軟件編程規(guī)范總則 1 排版 僅供內(nèi)部使用 8 (2)比較操作符 , 賦值操作符 =、 +=，算術(shù)操作符 +、 %，邏輯操作符 amp。amp。、amp。，位域操作符 、 ^等雙目操作符的前后加空格。 if (current_time = MAX_TIME_VALUE) a = b + c。 a *= 2。 a = b ^ 2。 (3)!、 ~、 ++、 、 amp。（地址運(yùn)算符）等單目操作符前后不加空格。 *p = 39。a39。 // 內(nèi)容操作 *與內(nèi)容之間 flag = !isEmpty。 // 非操作 !與內(nèi)容之間 p = amp。mem。 // 地址操作 amp。 與內(nèi)容之間 i++。 // ++,與內(nèi)容之間 (4)、 .前后不加空格。 pid = pid。 // 指針前后不加空格 (5) if、 for、 while、 switch等與后面的括號(hào)間應(yīng)加空格，使 if等關(guān)鍵字更為突出、明顯。 if (a = b amp。amp。 c d) 189。11：一行程序以小于 80字符為宜，不要寫(xiě)得過(guò)長(zhǎng)。 軟件編程規(guī)范總則 2 注釋 僅供內(nèi)部使用 9 2 注釋 185。21：一般情況下，源程序有效注釋量必須在 20％以上。 說(shuō)明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少 ，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。 185。22：說(shuō)明性文件（如頭文件 .h文件、 .inc文件、 .def文件、編譯說(shuō)明文件 .cfg等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要說(shuō)明。 示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。 /************************************************* Copyright (C), 19881999, Huawei Tech. Co., Ltd. File name: // 文件名 Author: Version: Date: // 作者、版本及完成日期 Description: // 用于詳細(xì)說(shuō)明此程序文件完成的主要功能，與其他模塊 // 或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控 // 制、順序、獨(dú)立或依賴等關(guān)系 Others: // 其它內(nèi)容的 說(shuō)明 Function List: // 主要函數(shù)列表，每條記錄應(yīng)包括函數(shù)名及功能簡(jiǎn)要說(shuō)明 1. .... History: // 修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改 // 者及修改內(nèi)容簡(jiǎn)述 1. Date: Author: Modification: 2. ... *************************************************/ 185。23：源 文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、模塊目的 /功能、主要函數(shù)及其功能、修改日志等。 示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。 軟件編程規(guī)范總則 2 注釋 僅供內(nèi)部使用 10 /************************************************************ Copyright (C), 19881999, Huawei Tech. Co., Ltd. FileName: Author: Version : Date: Description: // 模塊描述 Ver