華為代碼規(guī)范文檔

1、代碼規(guī)范文檔目錄 TOC o 1-2 u 1概述 PAGEREF _Toc232265114 h 51.1編寫目的 PAGEREF _Toc232265115 h 51.2文檔約定 PAGEREF _Toc232265116 h 51.3預(yù)期的讀者和閱讀建議 PAGEREF _Toc232265117 h 51.4參考文獻(xiàn) PAGEREF _Toc232265118 h 52排版要求 PAGEREF _Toc232265119 h 52.1程序塊縮進(jìn) PAGEREF _Toc232265120 h 52.2程序塊之間空行 PAGEREF _Toc232265121 h 52.3長(zhǎng)語(yǔ)句和長(zhǎng)表達(dá)式

2、 PAGEREF _Toc232265122 h 62.4循環(huán)、判斷等長(zhǎng)表達(dá)式或語(yǔ)句 PAGEREF _Toc232265123 h 72.5長(zhǎng)參數(shù) PAGEREF _Toc232265124 h 72.6短語(yǔ)句 PAGEREF _Toc232265125 h 82.7條件、循環(huán)語(yǔ)句 PAGEREF _Toc232265126 h 82.8語(yǔ)句對(duì)齊 PAGEREF _Toc232265127 h 82.9函數(shù)、過(guò)程和結(jié)構(gòu)等語(yǔ)句塊 PAGEREF _Toc232265128 h 92.10程序塊分界符 PAGEREF _Toc232265129 h 92.11操作符前后空格 PAGEREF _T

3、oc232265130 h 102.12其他 PAGEREF _Toc232265131 h 113注釋 PAGEREF _Toc232265132 h 113.1有效注釋量 PAGEREF _Toc232265133 h 113.2公司標(biāo)識(shí) PAGEREF _Toc232265134 h 113.3說(shuō)明性文件 PAGEREF _Toc232265135 h 123.4源文件頭 PAGEREF _Toc232265136 h 133.5函數(shù)頭部說(shuō)明 PAGEREF _Toc232265137 h 133.6注釋與代碼一致 PAGEREF _Toc232265138 h 143.7注釋內(nèi)容 PA

4、GEREF _Toc232265139 h 143.8注釋縮寫 PAGEREF _Toc232265140 h 143.9注釋位置 PAGEREF _Toc232265141 h 143.10變量、常量注釋 PAGEREF _Toc232265142 h 153.11數(shù)據(jù)結(jié)構(gòu)的注釋 PAGEREF _Toc232265143 h 153.12全局變量 PAGEREF _Toc232265144 h 163.13注釋縮排 PAGEREF _Toc232265145 h 163.14注釋與代碼之間空行 PAGEREF _Toc232265146 h 173.15變量定義、分支語(yǔ)句 PAGEREF

5、_Toc232265147 h 173.16其他 PAGEREF _Toc232265148 h 194標(biāo)識(shí)符命名 PAGEREF _Toc232265149 h 204.1命名清晰 PAGEREF _Toc232265150 h 204.2特殊命名需注釋 PAGEREF _Toc232265151 h 214.3命名風(fēng)格保持一致 PAGEREF _Toc232265152 h 214.4變量命名 PAGEREF _Toc232265153 h 214.5命名規(guī)范與系統(tǒng)風(fēng)格一致 PAGEREF _Toc232265154 h 214.6其他 PAGEREF _Toc232265155 h 22

6、5可讀性 PAGEREF _Toc232265156 h 235.1運(yùn)算符優(yōu)先級(jí) PAGEREF _Toc232265157 h 235.2避免直接使用數(shù)字作為標(biāo)識(shí)符 PAGEREF _Toc232265158 h 235.3其他 PAGEREF _Toc232265159 h 246變量、結(jié)構(gòu) PAGEREF _Toc232265160 h 256.1公共變量 PAGEREF _Toc232265161 h 256.2公共變量說(shuō)明 PAGEREF _Toc232265162 h 256.3公共變量訪問(wèn)說(shuō)明 PAGEREF _Toc232265163 h 256.4公共變量賦值 PAGEREF

7、 _Toc232265164 h 266.5防止局部變量與公共變量同名。 PAGEREF _Toc232265165 h 266.6嚴(yán)禁使用未經(jīng)初始化的變量作為右值。 PAGEREF _Toc232265166 h 266.7其他 PAGEREF _Toc232265167 h 267函數(shù)、過(guò)程 PAGEREF _Toc232265168 h 347.1對(duì)所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理。 PAGEREF _Toc232265169 h 347.2明確函數(shù)功能，精確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)。 PAGEREF _Toc232265170 h 347.3局部變量 PAGEREF _To

8、c232265171 h 347.4全局變量 PAGEREF _Toc232265172 h 347.5接口函數(shù)參數(shù) PAGEREF _Toc232265173 h 357.6其他 PAGEREF _Toc232265174 h 358可測(cè)性 PAGEREF _Toc232265175 h 448.1調(diào)測(cè)開關(guān) PAGEREF _Toc232265176 h 448.2打印信息 PAGEREF _Toc232265177 h 458.3單元測(cè)試 PAGEREF _Toc232265178 h 458.4集成測(cè)試 PAGEREF _Toc232265179 h 458.5斷言使用 PAGEREF

9、_Toc232265180 h 458.6設(shè)置與取消有關(guān)測(cè)試手段時(shí)，不能影響軟件功能功能 PAGEREF _Toc232265181 h 488.7版本維護(hù) PAGEREF _Toc232265182 h 488.8其他 PAGEREF _Toc232265183 h 489程序效率 PAGEREF _Toc232265184 h 509.1編程時(shí)要經(jīng)常注意代碼的效率。 PAGEREF _Toc232265185 h 509.2提高代碼效率 PAGEREF _Toc232265186 h 509.3全局效率高于局部效率 PAGEREF _Toc232265187 h 519.4提高代碼空間效率

10、 PAGEREF _Toc232265188 h 519.5循環(huán)體內(nèi)工作量最小化 PAGEREF _Toc232265189 h 529.6其他 PAGEREF _Toc232265190 h 5310質(zhì)量保證 PAGEREF _Toc232265191 h 5610.1在軟件設(shè)計(jì)過(guò)程中構(gòu)筑軟件質(zhì)量。 PAGEREF _Toc232265192 h 5610.2代碼質(zhì)量保證優(yōu)先原則 PAGEREF _Toc232265193 h 5610.3只引用屬于自己的存貯空間。 PAGEREF _Toc232265194 h 5610.4防止引用已經(jīng)釋放的內(nèi)存空間。 PAGEREF _Toc232265

11、195 h 5610.5內(nèi)存及時(shí)釋放 PAGEREF _Toc232265196 h 5710.6文件句柄及時(shí)關(guān)閉 PAGEREF _Toc232265197 h 5710.7防止內(nèi)存操作越界 PAGEREF _Toc232265198 h 5810.8認(rèn)真處理程序所能遇到的各種出錯(cuò)情況 PAGEREF _Toc232265199 h 5910.9初始化變量 PAGEREF _Toc232265200 h 5910.10數(shù)據(jù)一致性檢查 PAGEREF _Toc232265201 h 5910.11嚴(yán)禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置 PAGEREF _Toc232265202 h 591

12、0.12不能隨意改變與其它模塊的接口 PAGEREF _Toc232265203 h 5910.13系統(tǒng)接口 PAGEREF _Toc232265204 h 5910.14編程時(shí)，要防止差1錯(cuò)誤 PAGEREF _Toc232265205 h 6110.15操作符檢查 PAGEREF _Toc232265206 h 6110.16分支語(yǔ)句寫完整 PAGEREF _Toc232265207 h 6210.17使用return語(yǔ)句 PAGEREF _Toc232265208 h 6210.18不要濫用goto語(yǔ)句 PAGEREF _Toc232265209 h 6210.19其他 PAGEREF

13、_Toc232265210 h 6211代碼編輯、編譯、審查 PAGEREF _Toc232265211 h 6511.1打開編譯器的所有告警開關(guān)對(duì)程序進(jìn)行編譯 PAGEREF _Toc232265212 h 6511.2在產(chǎn)品軟件（項(xiàng)目組）中，要統(tǒng)一編譯開關(guān)選項(xiàng) PAGEREF _Toc232265213 h 6511.3通過(guò)代碼走讀及審查方式對(duì)代碼進(jìn)行檢查。 PAGEREF _Toc232265214 h 6511.4測(cè)試部測(cè)試產(chǎn)品之前，應(yīng)對(duì)代碼進(jìn)行抽查及評(píng)審 PAGEREF _Toc232265215 h 6511.5其他 PAGEREF _Toc232265216 h 6512代碼測(cè)試

14、、維護(hù) PAGEREF _Toc232265217 h 6712.1單元測(cè)試要求至少達(dá)到語(yǔ)句覆蓋 PAGEREF _Toc232265218 h 6712.2單元測(cè)試開始要跟蹤每一條語(yǔ)句，并觀察數(shù)據(jù)流及變量的變化 PAGEREF _Toc232265219 h 6712.3清理、整理或優(yōu)化后的代碼要經(jīng)過(guò)審查及測(cè)試。 PAGEREF _Toc232265220 h 6712.4代碼版本升級(jí)要經(jīng)過(guò)嚴(yán)格測(cè)試 PAGEREF _Toc232265221 h 6712.5使用工具軟件對(duì)代碼版本進(jìn)行維護(hù) PAGEREF _Toc232265222 h 6712.6正式版本上軟件的任何修改都應(yīng)有詳細(xì)的文檔記

15、錄 PAGEREF _Toc232265223 h 6712.7其他 PAGEREF _Toc232265224 h 6713宏 PAGEREF _Toc232265225 h 6813.1用宏定義表達(dá)式時(shí)，要使用完備的括號(hào) PAGEREF _Toc232265226 h 6813.2將宏所定義的多條表達(dá)式放在大括號(hào)中 PAGEREF _Toc232265227 h 6813.3使用宏時(shí)，不允許參數(shù)發(fā)生變化 PAGEREF _Toc232265228 h 69概述編寫目的為規(guī)范軟件開發(fā)人員的代碼編寫提供參考依據(jù)和統(tǒng)一標(biāo)準(zhǔn)。文檔約定說(shuō)明本文檔中所用到的專用術(shù)語(yǔ)定義或解釋，縮略詞定義。預(yù)期的讀者和

16、閱讀建議本文檔適用于所有軟件開發(fā)人員。參考文獻(xiàn) 列出有關(guān)的參考文件，如： a屬于本項(xiàng)目的其他已發(fā)表文件； b本文件中各處引用的文檔資料。 列出這些文件的標(biāo)題、作者，說(shuō)明能夠得到這些文件資料的來(lái)源。排版要求 程序塊縮進(jìn)程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個(gè)。說(shuō)明：對(duì)于由開發(fā)工具自動(dòng)生成的代碼可以有不一致。 程序塊之間空行相對(duì)獨(dú)立的程序塊之間、變量說(shuō)明之后必須加空行。示例：如下例子不符合規(guī)范。if (!valid_ni(ni) . / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.n

17、i;應(yīng)如下書寫if (!valid_ni(ni) . / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni; 長(zhǎng)語(yǔ)句和長(zhǎng)表達(dá)式較長(zhǎng)的語(yǔ)句（80字符）要分成多行書寫，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀。示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table

18、frame_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) & (n7stat_stat_item_valid (stat_item)& (act_task_tabletaskno.result_data != 0); 循環(huán)、判斷等

19、長(zhǎng)表達(dá)式或語(yǔ)句循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。示例：if (taskno max_act_task_number) & (n7stat_stat_item_valid (stat_item) . / program codefor (i = 0, j = 0; (i BufferKeywordword_index.word_length) & (j NewKeyword.word_length); i+, j+) . / program codefor (i = 0, j = 0; (i first_wor

20、d_length) & (j ），后不應(yīng)加空格。說(shuō)明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。由于留空格所產(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)志了。在長(zhǎng)語(yǔ)句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。示例：(1) 逗號(hào)、分號(hào)只在后面加空格。int a, b, c; (2)比較操作符, 賦值操作符=、 +=，算術(shù)操作符+、%，邏輯操作符&、&，位域操作符= MAX

21、_TIME_VALUE) a = b + c;a *= 2;a = b 2;(3)!、+、-、&（地址運(yùn)算符）等單目操作符前后不加空格。*p = a; / 內(nèi)容操作*與內(nèi)容之間flag = !isEmpty; / 非操作!與內(nèi)容之間p = &mem; / 地址操作& 與內(nèi)容之間i+; / +,-與內(nèi)容之間(4)-、.前后不加空格。p-id = pid; / -指針前后不加空格(5) if、for、while、switch等與后面的括號(hào)間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。if (a = b & c d)其他一行程序以小于80字符為宜，不要寫得過(guò)長(zhǎng)。注釋 有效注釋量一般情況下，源程序有效注釋

22、量必須在20以上。說(shuō)明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。 公司標(biāo)識(shí)在頭文件中加入公司標(biāo)識(shí)。示例如下：*/* */* Copyright (c) 1996-1998 XXXXXX Company */*xxxxxxxx 版權(quán)所有 1996-1998*/* */* PROPRIETARY RIGHTS ofXXXXXX Companyare involved in the */* subjectmatter of this material. All manufacturing, reproduction, use,*/

23、* andsales rights pertaining to this subject matter are governed by the*/* license agreement. The recipient of this software implicitly accepts */ /* the terms of the license. */* 本軟件文檔資料是xxx公司的資產(chǎn),任何人士閱讀和使用本資料必須獲得 */* 相應(yīng)的書面授權(quán),承擔(dān)保密責(zé)任和接受相應(yīng)的法律約束. */* */*/ 說(shuō)明性文件說(shuō)明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說(shuō)明文件.cfg等）頭

24、部應(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), 1996-1998, xxxxx. Co., Ltd. File name: / 文件名 Author: Version: Date: / 作者、版本及完成日期 Description: / 用于詳細(xì)說(shuō)明此程序文件完成的主要功能，與其他模塊 / 或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控 / 制、順序、獨(dú)立或依賴等關(guān)系 Oth

25、ers: / 其它內(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. .*/ 源文件頭 源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/* Copyright (C), 1988-1999, Xxxxxx Tech. Co., Ltd.

26、 FileName: test.cpp Author: Version : Date: Description: / 模塊描述 Version: / 版本信息 Function List: / 主要函數(shù)及其功能 1. History: / 歷史修改記錄 David 96/10/12 1.0 build this moudle */說(shuō)明：Description一項(xiàng)描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述。 函數(shù)頭部說(shuō)明 函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返

27、回值、調(diào)用關(guān)系（函數(shù)、表）等。示例：下面這段函數(shù)的注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。/* 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)系。 Output: / 對(duì)輸出參數(shù)的說(shuō)明。 Return:

28、 / 函數(shù)返回值的說(shuō)明 Others: / 其它說(shuō)明*/ 注釋與代碼一致邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。 注釋內(nèi)容注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。說(shuō)明：錯(cuò)誤的注釋不但無(wú)益反而有害。 注釋縮寫避免在注釋中使用縮寫。說(shuō)明：在使用縮寫時(shí)或之前，應(yīng)對(duì)縮寫進(jìn)行必要的說(shuō)明。 注釋位置注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語(yǔ)句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。示例：如下例子不符合規(guī)范。例1：/* get replicate sub system index and n

29、et indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;例2：repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */應(yīng)如下書寫/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.reps

30、sn_index;repssn_ni = ssn_dataindex.ni;變量、常量注釋對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說(shuō)明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */數(shù)據(jù)結(jié)構(gòu)的注釋數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須

31、加以注釋。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方。示例：可按如下形式說(shuō)明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVE N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this mes

32、sage */ N_UNITDATA_REQ, /* sccp users unit data transmission request*/;全局變量全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。示例：/* The ErrorCode when SCCP translate */* Global Title failure, as follows */ / 變量作用、含義/* 0 SUCCESS 1 GT Table error */* 2 GT error Others no use */ / 變量取值范圍/* only function

33、SCCPTranslate() in */* this modual can modify it, and other */* module can visit it through call */* the function GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode; 注釋縮排注釋與所描述內(nèi)容進(jìn)行同樣的縮排。說(shuō)明：可使程序排版整齊，并方便注釋的閱讀與理解。示例：如下例子，排版不整齊，閱讀稍感不方便。void example_fun( void )/* code one comments */ CodeBlock One /*

34、code two comments */ CodeBlock Two應(yīng)改為如下布局。void example_fun( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two注釋與代碼之間空行將注釋與其上面的代碼用空行隔開。示例：如下例子，顯得代碼過(guò)于緊湊。/* code one comments */program code one/* code two comments */program code two應(yīng)如下書寫/* code one comments */program co

35、de one/* code two comments */program code two變量定義、分支語(yǔ)句對(duì)變量的定義和分支語(yǔ)句（條件分支、循環(huán)語(yǔ)句等）必須編寫注釋。說(shuō)明：這些語(yǔ)句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對(duì)于維護(hù)人員來(lái)說(shuō)，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。示例（注意斜體加粗部分）：case CMD_UP: ProcessUp(); break;case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); if (.) . break;else ProcessCFW_B(); / now jump

36、into case CMD_Acase CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;case CMD_C: ProcessC(); break;case CMD_D: ProcessD(); break;.其他避免在一行代碼或表達(dá)式的中間插入注釋。說(shuō)明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。通過(guò)對(duì)函數(shù)或過(guò)程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。說(shuō)明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信

37、息。說(shuō)明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒(méi)必要的重復(fù)注釋信息。示例：如下注釋意義不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注釋則給出了額外有用的信息。 /* if mtp receive a message from links */if (receive_flag)在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。說(shuō)明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。示例：參見(jiàn)如下例子。if (.) / program code while (in

38、dex MAX_INDEX) / program code /* end of while (index MAX_INDEX) */ / 指明該條while語(yǔ)句結(jié)束 /* end of if (.)*/ / 指明是哪條if語(yǔ)句結(jié)束注釋格式盡量統(tǒng)一，建議使用“/* */”。注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語(yǔ)言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。說(shuō)明：注釋語(yǔ)言不統(tǒng)一，影響程序易讀性和外觀排版，出于對(duì)維護(hù)人員的考慮，建議使用中文。標(biāo)識(shí)符命名 命名清晰標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。說(shuō)明：較短的

39、單詞可通過(guò)去掉“元音”形成縮寫；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。示例：如下單詞的縮寫能夠被大家基本認(rèn)可。temp 可縮寫為 tmp ;flag 可縮寫為 flg ;statistic 可縮寫為 stat ;increment 可縮寫為 inc ;message 可縮寫為 msg ; 特殊命名需注釋命名中若使用特殊約定或縮寫，則要有注釋說(shuō)明。說(shuō)明：應(yīng)該在源文件的開始之處，對(duì)文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說(shuō)明。 命名風(fēng)格保持一致自己特有的命名風(fēng)格，要自始至終保持一致，不可來(lái)回變化。說(shuō)明：個(gè)人的命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則

40、的前提下，才可使用。（即命名規(guī)則中沒(méi)有規(guī)定到的地方才可有個(gè)人命名風(fēng)格）。 變量命名對(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í)間。示例：下面所示的局部變量名的定義方法可以借鑒。int liv_Width其變量名解釋如下：l 局部變量（Local） （其它：g 全局變量（Global）.）i 數(shù)據(jù)類型（Interger）v 變量（Variable） （其它：c 常量

41、（Const）.）Width 變量含義這樣可以防止局部變量與全局變量重名。 命名規(guī)范與系統(tǒng)風(fēng)格一致命名規(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允許。 其他 除非必要，不要用數(shù)字或較奇怪的字符來(lái)定義標(biāo)識(shí)符。示例：如下命名，使人產(chǎn)生疑惑。#define _EXAMPLE_0_TEST_#define _EXAMPLE_1_TE

42、ST_void set_sls00( BYTE sls );應(yīng)改為有意義的單詞命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_void set_udt_msg_sls( BYTE sls ); 在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突。說(shuō)明：對(duì)接口部分的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識(shí)等。 用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等。說(shuō)明：下面是一些在軟件中常用的反義詞組。add / remove begi

43、n / end create / destroy insert / delete first / last get / releaseincrement / decrement put / getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / paste up / down示例：int min_sum;int max_sum;int a

44、dd_user( BYTE *user_name );int delete_user( BYTE *user_name );3.6.4 除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義。可讀性 運(yùn)算符優(yōu)先級(jí)注意運(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ò)。示例：下列語(yǔ)句中的表達(dá)式word = (high 8) | low (1)if (a | b) & (a & c) (2)if (a | b) (c & d) (3)如果書寫為high 8 | l

45、owa | b & a & ca | b c & d由于high 8 | low = ( high 8) | low,a | b & a & c = (a | b) & (a & c)，(1)(2)不會(huì)出錯(cuò)，但語(yǔ)句不易理解；a | b c & d = a | （b c） & d，(3)造成了判斷條件出錯(cuò)。 避免直接使用數(shù)字作為標(biāo)識(shí)符避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來(lái)替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來(lái)代替。示例：如下的程序可讀性差。if (Trunkindex.trunk_state = 0) Trunkindex.trunk_state

46、= 1; . / program code應(yīng)改為如下形式。#define TRUNK_IDLE 0#define TRUNK_BUSY 1if (Trunkindex.trunk_state = TRUNK_IDLE) Trunkindex.trunk_state = TRUNK_BUSY; . / program code 其他 源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。說(shuō)明：便于程序閱讀和查找。示例：以下代碼布局不太合理。rect.length = 10;char_poi = str;rect.width = 5;若按如下形式書寫，可能更清晰一些。rect.length = 10;rect.

47、width = 5; / 矩形的長(zhǎng)與寬關(guān)系較密切，放在一起。char_poi = str; 不要使用難懂的技巧性很高的語(yǔ)句，除非很有必要時(shí)。說(shuō)明：高技巧語(yǔ)句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于算法。示例：如下表達(dá)式，考慮不周就可能出問(wèn)題，也較難理解。* stat_poi + += 1;* + stat_poi += 1;應(yīng)分別改為如下。*stat_poi += 1;stat_poi+; / 此二語(yǔ)句功能相當(dāng)于“ * stat_poi + += 1; ”+ stat_poi;*stat_poi += 1; / 此二語(yǔ)句功能相當(dāng)于“ * + stat_poi += 1;變量、結(jié)構(gòu)公共變量

48、去掉沒(méi)必要的公共變量。說(shuō)明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少?zèng)]必要的公共變量以降低模塊間的耦合度。 公共變量說(shuō)明仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。說(shuō)明：在對(duì)變量聲明的同時(shí)，應(yīng)對(duì)其含義、作用及取值范圍進(jìn)行注釋說(shuō)明，同時(shí)若有必要還應(yīng)說(shuō)明與其它變量的關(guān)系。 公共變量訪問(wèn)說(shuō)明明確公共變量與操作此公共變量的函數(shù)或過(guò)程的關(guān)系，如訪問(wèn)、修改及創(chuàng)建等。說(shuō)明：明確過(guò)程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以及代碼維護(hù)等。這種關(guān)系的說(shuō)明可在注釋或文檔中描述。示例：在源文件中，可按如下注釋形式說(shuō)明。RELATION System_Init Input

49、_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表示訪問(wèn)。其中，函數(shù)Input_Rec、Stat_Score都可修改變量Score，故此變量將引起函數(shù)間較大的耦合，并可能增加代碼測(cè)試、維護(hù)的難度。公共變量賦值當(dāng)向公

50、共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。說(shuō)明：對(duì)公共變量賦值時(shí)，若有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、穩(wěn)定性。 防止局部變量與公共變量同名。說(shuō)明：若使用了較好的命名規(guī)則，那么此問(wèn)題可自動(dòng)消除。 嚴(yán)禁使用未經(jīng)初始化的變量作為右值。說(shuō)明：特別是在C/C+中引用未經(jīng)賦值的指針，經(jīng)常會(huì)引起系統(tǒng)崩潰。 其他 防止多個(gè)模塊共用公共變量構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問(wèn)的公共變量，防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。說(shuō)明：降低公共變量耦合度。 數(shù)據(jù)類型使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)

51、系密切的變量。說(shuō)明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類型，有利于程序的移植。示例：如下例子（在DOS下BC3.1環(huán)境中），在移植時(shí)可能產(chǎn)生問(wèn)題。void main() register int index; / 寄存器變量 _AX = 0 x4000; / _AX是BC3.1提供的寄存器“偽變量” . / program code 結(jié)構(gòu)結(jié)構(gòu)的功能要單一，是針對(duì)一種事務(wù)的抽象。說(shuō)明：設(shè)計(jì)結(jié)構(gòu)時(shí)應(yīng)力爭(zhēng)使結(jié)構(gòu)代表一種現(xiàn)實(shí)事務(wù)的抽象，而不是同時(shí)代表多種。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒(méi)有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。示例：如下結(jié)構(gòu)不太清晰、合理。typedef struct STU

52、DENT_STRU unsigned char name8; /* students name */ unsigned char age; /* students age */ unsigned char sex; /* students sex, as follows */ /* 0 - FEMALE; 1 - MALE */ unsigned char teacher_name8; /* the student teachers name */ unisgned char teacher_sex; /* his teacher sex */ STUDENT;若改為如下，可能更合理些。typ

53、edef struct TEACHER_STRU unsigned char name8; /* teacher name */ unisgned char sex; /* teacher sex, as follows */ /* 0 - FEMALE; 1 - MALE */ TEACHER;typedef struct STUDENT_STRU unsigned char name8; /* students name */ unsigned char age; /* students age */ unsigned char sex; /* students sex, as follo

54、ws */ /* 0 - FEMALE; 1 - MALE */ unsigned int teacher_ind; /* his teacher index */ STUDENT; 不要設(shè)計(jì)面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)說(shuō)明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。 不同結(jié)構(gòu)間的關(guān)系不要過(guò)于復(fù)雜說(shuō)明：若兩個(gè)結(jié)構(gòu)間關(guān)系較復(fù)雜、密切，那么應(yīng)合為一個(gè)結(jié)構(gòu)。示例：如下兩個(gè)結(jié)構(gòu)的構(gòu)造不合理。typedef struct PERSON_ONE_STRU unsigned char name8; unsigned char addr40; unsigned char sex; unsigned

55、char city15; PERSON_ONE;typedef struct PERSON_TWO_STRU unsigned char name8; unsigned char age; unsigned char tel; PERSON_TWO;由于兩個(gè)結(jié)構(gòu)都是描述同一事物的，那么不如合成一個(gè)結(jié)構(gòu)。typedef struct PERSON_STRU unsigned char name8; unsigned char age; unsigned char sex; unsigned char addr40; unsigned char city15; unsigned char tel;

56、 PERSON; 結(jié)構(gòu)中元素的個(gè)數(shù)應(yīng)適中若結(jié)構(gòu)中元素個(gè)數(shù)過(guò)多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個(gè)數(shù)。說(shuō)明：增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。示例：假如認(rèn)為如上的_PERSON結(jié)構(gòu)元素過(guò)多，那么可如下對(duì)之劃分。typedef struct PERSON_BASE_INFO_STRU unsigned char name8; unsigned char age; unsigned char sex; PERSON_BASE_INFO;typedef struct PERSON_ADDRESS_STRU unsigned char addr40; unsigned

57、char city15; unsigned char tel; PERSON_ADDRESS;typedef struct PERSON_STRU PERSON_BASE_INFO person_base; PERSON_ADDRESS person_addr; PERSON; 結(jié)構(gòu)中元素布局和排列仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象。說(shuō)明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。typedef struct EXAMPLE_STRU unsigned int valid: 1;

58、PERSON person; unsigned int set_flg: 1; EXAMPLE;若改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。typedef struct EXAMPLE_STRU unsigned int valid: 1; unsigned int set_flg: 1; PERSON person ; EXAMPLE; 結(jié)構(gòu)中的保留項(xiàng)結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級(jí)，并為某些未來(lái)可能的應(yīng)用保留余地（如預(yù)留一些空間等）。說(shuō)明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標(biāo)志之一。如果要想使產(chǎn)品具有較好的前向兼容，那么在產(chǎn)品設(shè)計(jì)之初就應(yīng)為以后版本升級(jí)保留一

59、定余地，并且在產(chǎn)品升級(jí)時(shí)必須考慮前一版本的各種特性。 留心具體語(yǔ)言及編譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細(xì)節(jié)。說(shuō)明：如在C語(yǔ)言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部變量將在“堆?！敝猩?。這些細(xì)節(jié)對(duì)程序質(zhì)量的保證非常重要。 編程時(shí)，要注意數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)換。說(shuō)明：當(dāng)進(jìn)行數(shù)據(jù)類型強(qiáng)制轉(zhuǎn)換時(shí)，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而這些細(xì)節(jié)若考慮不周，就很有可能留下隱患。 對(duì)編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認(rèn)識(shí)。示例：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。char chr;unsigned short int exam;chr = -

60、1;exam = chr; / 編譯器不產(chǎn)生告警，此時(shí)exam為0 xFFFF。 盡量減少?zèng)]有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換。 合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換。 對(duì)自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的統(tǒng)一。說(shuō)明：使用自定義類型，可以彌補(bǔ)編程語(yǔ)言提供類型少、信息量不足的缺點(diǎn)，并能使程序清晰、簡(jiǎn)潔。示例：可參考如下方式聲明自定義數(shù)據(jù)類型。下面的聲明可使數(shù)據(jù)類型的使用簡(jiǎn)潔、明了。typedef unsigned char BYTE;typedef unsigned short WORD;typedef u