【正文】 合規(guī)范。不再有用的注釋要?jiǎng)h除 185。 /************************************************* Function: // 函數(shù)名稱 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)系。 /************************************************************ Copyright (C), 19881999, Huawei 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)系等。2 2：說(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)。11：一行程序以小于 80字符為宜，不要寫得過(guò)長(zhǎng)。 // 指針前后不加空格 (5) if、 for、 while、 switch等與后面的括號(hào)間應(yīng)加空格，使 if 等關(guān)鍵字更為突出、明顯。 // 地址操作 amp。a39。 a = b ^ 2。、 amp。 示例： (1) 逗號(hào)、分號(hào)只在后面加空格。1 11：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－ ），后不應(yīng)加空格。1 10：程序塊的分界符（如 C/C++語(yǔ)言的大括號(hào) ?{?和 ?}?）應(yīng) 各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。 } 185。 185。 = 0。 (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT))。 (j second_word_length)。 (j )。amp。amp。 act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item )。 repssn_ni = ssn_data[index].ni。 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index。1 1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為 4 個(gè) 說(shuō)明：對(duì)于由開(kāi)發(fā)工具自動(dòng)生成的代碼可以有不一致。 185。 repssn_ni = ssn_data[index].ni。 185。 report_or_not_flag = ((taskno MAX_ACT_TASK_NUMBER) amp。 (act_task_table[taskno].result_data != 0))。 (n7stat_stat_item_valid (stat_item))) { ... // program code } for (i = 0, j = 0。 i++, j++) { ... // program code } for (i = 0, j = 0。 i++, j++) { ... // program code } 185。 n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object )。 = 0。1 7： if、 for、 do、 while、 case、 switch、 default等語(yǔ)句自占一行，且 if、 for、 do、 while等語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào) {} 示例：如下例子不符合規(guī)范。1 8：對(duì)齊只使用空格鍵，不使用 TAB鍵 說(shuō)明：以免用不同的編輯器閱讀程序時(shí)，因 TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用 BC 作為編輯器合版本，因?yàn)?BC 會(huì)自動(dòng)將 8 個(gè)空格變?yōu)橐粋€(gè) TAB鍵，因此使用 BC 合入的版本大多會(huì)將縮進(jìn)變亂。在函數(shù)體的開(kāi)始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及 if、 for、 do、 while、switch、 case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式 示例：如下例子不符合規(guī)范。 說(shuō)明：采用這種松散方式編寫代碼的目的是使代碼更加清晰 由于留空 格所產(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)志了。 int a, b, c。位域操作符、 ^等雙目操作符的前后加空格。 (3)!、 ~、 ++、 、 amp。 // 內(nèi)容操作 *與內(nèi)容之間 flag = !isEmpty。 與內(nèi)容之間 i++。 if (a = b amp。 〔二〕 ======[ 注釋 ]======= 185。 /************************************************* 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。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述。 Output: // 對(duì)輸出參數(shù)的說(shuō)明。2 6：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性 說(shuō)明：錯(cuò)誤的注釋不但無(wú)益反而有害。 例 1： /* get replicate sub system index and indicator */ repssn_ind = ssn_data[index].repssn_index。 /* get replicate sub system index and indicator */ 應(yīng)如下書寫 /* get replicate sub system index and indicator */ repssn_ind = ssn_data[index].repssn_index。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方 示例： /* active statistic task number */ define MAX_ACT_TASK_NUMBER 1000 define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */ 185。s unit data transmission request*/ }。2 12：注釋與所描述內(nèi)容進(jìn)行同樣的縮排 說(shuō)明：可使程序排版整齊，并方便注釋的閱讀與理解。2 13：將注釋與其上面的代碼用空行隔開(kāi) 示例：如下例子，顯得代碼過(guò)于緊湊。2 15：對(duì)于 switch語(yǔ)句下的 case語(yǔ)句，如果因?yàn)樘厥馇闆r需要處理完一個(gè) case后進(jìn)入下一個(gè) case處理，必須在該 case語(yǔ)句處理完、下一個(gè) case語(yǔ)句前加上明確的注釋 說(shuō)明：這樣比較清楚程序編寫者的意圖，有效防止無(wú)故遺漏 break語(yǔ)句。 break。 // now jump into case CMD_A } case CMD_A: ProcessA()。 case CMD_C: ProcessC()。 ... 189。 189。 /* if mtp receive a message from links */ if (receive_flag) 189。25：注釋格式盡量統(tǒng)一，建議使用 “/* …… */” 189。 示例：如下單詞的縮寫能夠被大家基本認(rèn)可。 increment 可縮寫為 inc 。 185。3 4：對(duì)于變量命名，禁止取單個(gè)字符（如 i、 j、 k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但 i、 j、 k作局部循環(huán)變量是允許的 說(shuō)明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如 i寫成 j），而編譯時(shí)又檢查不出來(lái)，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。3 5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用 UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標(biāo)識(shí)如標(biāo)識(shí)成員變量或全局變量的 m_和 g_，其后加上大小寫混排的方式是允許的 示例： Add_User不允許， add_user、 AddUser、 m_AddUser允許。 應(yīng)改為有意義的單詞命名 define _EXAMPLE_UNIT_TEST_ define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls )。 189。 int add_user( BYTE *user_name )。4 1：注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí) 說(shuō)明：防止閱讀程序時(shí)產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級(jí)與設(shè)計(jì)思想不符而導(dǎo)致程序出錯(cuò)。 c)) (2) if ((a | b) (c amp。 c a | b c amp。 c = (a | b) amp。 d = a | （ b c） amp。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來(lái)代替 示例：如下的程序可讀性差。 ... // program code } 189。 char_poi = str。 = 5。42：不要使用難懂的技巧性很高的語(yǔ)句，除非很有必要時(shí) 說(shuō)明：高技巧語(yǔ)句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于算法。 應(yīng)分別改為如下 : *stat_poi += 1。 *stat_poi += 1。 185。這種關(guān)系的說(shuō)明可在注釋或文檔中描述。 185。 185。 189。 // 寄存器變量 _AX = 0x4000。 示例：如下結(jié)構(gòu)不太清晰、合理。 /* student39。 1 MALE */ unsigned char teacher_name[8]。 若改為