【正文】 ..189。case CMD_C: ProcessC()。 // now jump into case CMD_A}case CMD_A: ProcessA()。 break。說(shuō)明：這樣比較清楚程序編寫(xiě)者的意圖，有效防止無(wú)故遺漏break語(yǔ)句。 214：對(duì)變量的定義和分支語(yǔ)句（條件分支、循環(huán)語(yǔ)句等）必須編寫(xiě)注釋。void example_fun( void ){ /* code one ments */ CodeBlock One /* code two ments */ CodeBlock Two}185。 212：注釋與所描述內(nèi)容進(jìn)行同樣的縮排。185。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋?xiě)?yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方。 29：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋?zhuān)f(shuō)明其物理含義。repssn_ni = ssn_data[index].ni。示例：如下例子不符合規(guī)范。規(guī)則27：避免在注釋中使用縮寫(xiě)，特別是非常用縮寫(xiě)。不再有用的注釋要?jiǎng)h除。/************************************************* Function: // 函數(shù)名稱(chēng) Description: // 函數(shù)功能、性能等的描述 Calls: // 被本函數(shù)調(diào)用的函數(shù)清單 Called By: // 調(diào)用本函數(shù)的函數(shù)清單 Table Accessed: // 被訪(fǎng)問(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)系。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述。/************************************************* Copyright (C), 19881999, Huawei Tech. Co., Ltd. File name: // 文件名 Author: Version: Date: // 作者、版本及完成日期 Description: // 用于詳細(xì)說(shuō)明此程序文件完成的主要功能，與其他模塊 // 或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控 // 制、順序、獨(dú)立或依賴(lài)等關(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。說(shuō)明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。 c d)189。pid = pid。mem。*p = 39。a *= 2。amp。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。 111：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－），后不應(yīng)加空格。在函數(shù)體的開(kāi)始、類(lèi)的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。185。應(yīng)如下書(shū)寫(xiě)：if (pUserCR == NULL){ return。185。 = 0。n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object )。 15：若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧? (i first_word_length) amp。 (i BufferKeyword[word_index].word_length) amp。 14：循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。 (n7stat_stat_item_valid (stat_item)) amp。act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied。repssn_ni = ssn_data[index].ni。示例：如下例子不符合規(guī)范。 11：程序塊要采用縮進(jìn)風(fēng)格編寫(xiě)，縮進(jìn)的空格數(shù)為4個(gè)。說(shuō)明：對(duì)于由開(kāi)發(fā)工具自動(dòng)生成的代碼可以有不一致。if (!valid_ni(ni)){ ... // program code}repssn_ind = ssn_data[index].repssn_index。185。act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item )。amp。示例：if ((taskno max_act_task_number) amp。amp。amp。示例：n7stat_str_pare((BYTE *) amp。185。 = 0。 17：if、for、do、while、case、switch、default等語(yǔ)句自占一行，且if、for、do、while等語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào){}。}185。 19：函數(shù)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格，case語(yǔ)句下的情況處理語(yǔ)句也要遵從語(yǔ)句縮進(jìn)要求。示例：如下例子不符合規(guī)范。說(shuō)明：采用這種松散方式編寫(xiě)代碼的目的是使代碼更加清晰。示例：(1) 逗號(hào)、分號(hào)只在后面加空格。、amp。a = b ^ 2。a39。 // 地址操作amp。 // 指針前后不加空格(5) if、for、while、switch等與后面的括號(hào)間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。 11：一行程序以小于80字符為宜，不要寫(xiě)得過(guò)長(zhǎng)。185。 23：源文件頭部應(yīng)進(jìn)行注釋?zhuān)谐觯喊鏅?quán)說(shuō)明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。185。 Output: // 對(duì)輸出參數(shù)的說(shuō)明。185。說(shuō)明：在使用縮寫(xiě)時(shí)或之前，應(yīng)對(duì)縮寫(xiě)進(jìn)行必要的說(shuō)明。例1：/* get replicate sub system index and net indicator */repssn_ind = ssn_data[index].repssn_index。/* get replicate sub system index and net indicator */應(yīng)如下書(shū)寫(xiě)/* get replicate sub system index and net indicator */repssn_ind = ssn_data[index].repssn_index。變量、常量、宏的注釋?xiě)?yīng)放在其上方相鄰位置或右方。示例：可按如下形式說(shuō)明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。 211：全局變量要有較詳細(xì)的注釋?zhuān)▽?duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。說(shuō)明：可使程序排版整齊，并方便注釋的閱讀與理解。 213：將注釋與其上面的代碼用空行隔開(kāi)。說(shuō)明：這些語(yǔ)句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對(duì)于維護(hù)人員來(lái)說(shuō)，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。示例（注意斜體加粗部分）：case CMD_UP: ProcessUp()。case CMD_FWD: ProcessFwd()。 break。 break。 21：避免在一行代碼或表達(dá)式的中間插入注釋。說(shuō)明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。示例：如下注釋意義不大。說(shuō)明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。189。 31：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫(xiě)，避免使人產(chǎn)生誤解。flag 可縮寫(xiě)為 flg 。185。 33：自己特有的命名風(fēng)格，要自始至終保持一致，不可來(lái)回變化。 34：對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類(lèi)型、數(shù)據(jù)類(lèi)型等，但i、j、k作局部循環(huán)變量是允許的。185。 31：除非必要，不要用數(shù)字或較奇怪的字符來(lái)定義標(biāo)識(shí)符。189。189。int max_sum。 34：除了編譯開(kāi)關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類(lèi)以下劃線(xiàn)開(kāi)始和結(jié)尾的定義。示例：下列語(yǔ)句中的表達(dá)式word = (high 8) | low (1)if ((a | b) amp。 d)) (3)如果書(shū)寫(xiě)為high 8 | lowa | b amp。 d由于high 8 | low = ( high 8) | low,a | b amp。amp。 d，(3)造成了判斷條件出錯(cuò)。示例：如下的程序可讀性差。 ... // program code}189。 = 10。 = 10。189。* stat_poi ++ += 1。stat_poi++。 // 此二語(yǔ)句功能相當(dāng)于“ * ++ stat_poi += 1。185。 53：明確公共變量與操作此公共變量的函數(shù)或過(guò)程的關(guān)系，如訪(fǎng)問(wèn)、修改及創(chuàng)建等。RELATION System_Init Input_Rec Print_Rec Stat_ScoreStudent Create Modify Access AccessScore 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表示訪(fǎng)問(wèn)。說(shuō)明：對(duì)公共變量賦值時(shí)，若有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、穩(wěn)定性。185。 51：構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪(fǎng)問(wèn)的公共變量，防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。說(shuō)明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類(lèi)型，有利于程序的移植。 // “偽變量” ... // program code}189。示例：如下結(jié)構(gòu)不太清晰、合理。 /* student39。 1 MALE */ unsigned char teacher_name[8]。若改為如下，可能更合理些。 1 MALE */} TEACHER。 /* student39。 1 MALE */ unsigned int teacher_ind。說(shuō)明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。示例：如下兩個(gè)結(jié)構(gòu)的構(gòu)造不合理。 unsigned char city[15]。 unsigned char tel。 unsigned char age。 unsigned char tel。若結(jié)構(gòu)中元素個(gè)數(shù)過(guò)多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個(gè)數(shù)。 unsigned char age。 unsigned char city[15]。 PERSON_ADDRESS person_addr。說(shuō)明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。 unsigned int set_flg: 1。 unsigned int set_flg: 1。 58：結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級(jí)，并為某些未來(lái)可能的應(yīng)用保留余地（如預(yù)留一些空間等）。 59：留心具體語(yǔ)言及編譯器處理不同數(shù)據(jù)類(lèi)型的原則及有關(guān)細(xì)節(jié)。 510：編程時(shí)，要注意數(shù)據(jù)類(lèi)型的強(qiáng)制轉(zhuǎn)換。示例：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。exam = chr。189。注意其命名方式在同一產(chǎn)品中的統(tǒng)一。typedef unsigned char BYTE。typedef float DISTANCE。說(shuō)明：比如Intel CPU與68360 CPU