【正文】 Tech. Co., Ltd. FileName: Author: Version : Date: Description: // 模塊描述 Version: // 版本信息 Function List: // 主要函數(shù)及其功能 1. History: // 歷史修改記錄 author time version desc David 96/10/12 build this moudle ***********************************************************/說(shuō)明：Description一項(xiàng)描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文件關(guān)系等。 23：源文件頭部應(yīng)進(jìn)行注釋?zhuān)谐觯喊鏅?quán)說(shuō)明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。185。 21：一般情況下，源程序有效注釋量必須在20％以上。 11：一行程序以小于80字符為宜，不要寫(xiě)得過(guò)長(zhǎng)。amp。 // 指針前后不加空格(5) if、for、while、switch等與后面的括號(hào)間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。 // ++,與內(nèi)容之間(4)、.前后不加空格。 // 地址操作amp。 // 非操作!與內(nèi)容之間p = amp。a39。（地址運(yùn)算符）等單目操作符前后不加空格。a = b ^ 2。if (current_time = MAX_TIME_VALUE) a = b + c。、amp。 (2)比較操作符, 賦值操作符=、 +=，算術(shù)操作符+、%，邏輯操作符amp。示例：(1) 逗號(hào)、分號(hào)只在后面加空格。在長(zhǎng)語(yǔ)句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。說(shuō)明：采用這種松散方式編寫(xiě)代碼的目的是使代碼更加清晰。for (...) { ... // program code}if (...) { ... // program code}void example_fun( void ){ ... // program code}185。示例：如下例子不符合規(guī)范。 110：程序塊的分界符（如C/C++語(yǔ)言的大括號(hào)‘{’和‘}’）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。 19：函數(shù)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格，case語(yǔ)句下的情況處理語(yǔ)句也要遵從語(yǔ)句縮進(jìn)要求。說(shuō)明：以免用不同的編輯器閱讀程序時(shí)，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因?yàn)锽C會(huì)自動(dòng)將8個(gè)空格變?yōu)橐粋€(gè)TAB鍵，因此使用BC合入的版本大多會(huì)將縮進(jìn)變亂。}185。if (pUserCR == NULL) return。 17：if、for、do、while、case、switch、default等語(yǔ)句自占一行，且if、for、do、while等語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào){}。 = 0。 = 0。示例：如下例子不符合規(guī)范。185。 (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT))。示例：n7stat_str_pare((BYTE *) amp。 i++, j++){ ... // program code }185。amp。 i++, j++){ ... // program code}for (i = 0, j = 0。amp。 (n7stat_stat_item_valid (stat_item))){ ... // program code}for (i = 0, j = 0。示例：if ((taskno max_act_task_number) amp。185。amp。amp。act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item )。示例： = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL )。185。應(yīng)如下書(shū)寫(xiě)if (!valid_ni(ni)){ ... // program code}repssn_ind = ssn_data[index].repssn_index。if (!valid_ni(ni)){ ... // program code}repssn_ind = ssn_data[index].repssn_index。 12：相對(duì)獨(dú)立的程序塊之間、變量說(shuō)明之后必須加空行。說(shuō)明：對(duì)于由開(kāi)發(fā)工具自動(dòng)生成的代碼可以有不一致。目 錄1 排版62 注釋113 標(biāo)識(shí)符命名184 可讀性205 變量、結(jié)構(gòu)226 函數(shù)、過(guò)程287 可測(cè)性368 程序效率409 質(zhì)量保證4410 代碼編輯、編譯、審查5011 代碼測(cè)試、維護(hù)5212 宏5359 / 591 排版185。 11：程序塊要采用縮進(jìn)風(fēng)格編寫(xiě)，縮進(jìn)的空格數(shù)為4個(gè)。185。示例：如下例子不符合規(guī)范。repssn_ni = ssn_data[index].ni。repssn_ni = ssn_data[index].ni。 13：較長(zhǎng)的語(yǔ)句（80字符）要分成多行書(shū)寫(xiě)，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀。act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied。report_or_not_flag = ((taskno MAX_ACT_TASK_NUMBER) amp。 (n7stat_stat_item_valid (stat_item)) amp。 (act_task_table[taskno].result_data != 0))。 14：循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。amp。 (i BufferKeyword[word_index].word_length) amp。 (j )。 (i first_word_length) amp。 (j second_word_length)。 15：若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧?stat_object, (BYTE *) amp。n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object )。 16：不允許把多個(gè)短語(yǔ)句寫(xiě)在一行中，即一行只寫(xiě)一條語(yǔ)句。 = 0。應(yīng)如下書(shū)寫(xiě) = 0。185。 示例：如下例子不符合規(guī)范。應(yīng)如下書(shū)寫(xiě)：if (pUserCR == NULL){ return。 18：對(duì)齊只使用空格鍵，不使用TAB鍵。185。185。在函數(shù)體的開(kāi)始、類(lèi)的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。for (...) { ... // program code}if (...) { ... // program code }void example_fun( void ) { ... // program code }應(yīng)如下書(shū)寫(xiě)。 111：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－），后不應(yīng)加空格。由于留空格所產(chǎn)生的清晰性是相對(duì)的，所以，在已經(jīng)非常清晰的語(yǔ)句中沒(méi)有必要再留空格，如果語(yǔ)句已足夠清晰則括號(hào)內(nèi)側(cè)(即左括號(hào)后面和右括號(hào)前面)不需要加空格，多重括號(hào)間不必加空格，因?yàn)樵贑/C++語(yǔ)言中括號(hào)已經(jīng)是最清晰的標(biāo)志了。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。int a, b, c。amp。位域操作符、^等雙目操作符的前后加空格。a *= 2。(3)!、~、++、amp。*p = 39。 // 內(nèi)容操作*與內(nèi)容之間flag = !isEmpty。mem。 與內(nèi)容之間i++。pid = pid。if (a = b amp。 c d)189。 2 注釋185。說(shuō)明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。 22：說(shuō)明性文件（、.inc文件、.def文件、）頭部應(yīng)進(jìn)行注釋?zhuān)⑨尡仨毩谐觯喊鏅?quán)說(shuō)明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要說(shuō)明。/************************************************* 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。示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述。 24：函數(shù)頭部應(yīng)進(jìn)行注釋?zhuān)谐觯汉瘮?shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。/************************************************* Function: // 函數(shù)名稱(chēng) Description: // 函數(shù)功能、性能等的描述 Calls: // 被本函數(shù)調(diào)用的函數(shù)清單 Called By: // 調(diào)用本函數(shù)的函數(shù)清單 Table Accessed: // 被訪問(wèn)的表（此項(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)系。 Return: // 函數(shù)返回值的說(shuō)明 Others: // 其它說(shuō)明*************************************************/185。不再有用的注釋要?jiǎng)h除。 26：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。規(guī)則27：避免在注釋中使用縮寫(xiě)，特別是非常用縮寫(xiě)。185。示例：如下例子不符合規(guī)范。repssn_ni = ssn_data[index].ni。repssn_ni = ssn_data[index].ni。repssn_ni = ssn_data[index].ni。 29：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋?zhuān)f(shuō)明其物理含義。示例：/* active statistic task number */define MAX_ACT_TASK_NUMBER 1000define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */185。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋