C語言編程規(guī)范

C語言編程規(guī)范（僅供參考）

1.基本要求

1.1程序結(jié)構(gòu)清析，簡單易懂，單個函數(shù)的程序行數(shù)不得超過100行。

1.2打算干什么，要簡單，直接了當(dāng)，代碼精簡，避免垃圾程序。

1.3盡量使用標(biāo)準(zhǔn)庫函數(shù)和公共函數(shù)。

1.4不要隨意定義全局變量，盡量使用局部變量。

1.5使用括號以避免二義性。

2.可讀性要求

2.1可讀性第一，效率第二。

2.2保持注釋與代碼完全一致。

2.3每個源程序文件，都有文件頭說明，說明規(guī)格見規(guī)范。

2.4每個函數(shù)，都有函數(shù)頭說明，說明規(guī)格見規(guī)范。

2.5主要變量（結(jié)構(gòu)、聯(lián)合、類或?qū)ο螅┒x或引用時，注釋能反映其含義。

2.7常量定義（DEFINE）有相應(yīng)說明。

2.8處理過程的每個階段都有相關(guān)注釋說明。

2.9在典型算法前都有注釋。

2.10利用縮進(jìn)來顯示程序的邏輯結(jié)構(gòu)，縮進(jìn)量一致并以Tab鍵為單位，定義Tab為6個

字節(jié)。

2.11循環(huán)、分支層次不要超過五層。

2.12注釋可以與語句在同一行，也可以在上行。

2.13空行和空白字符也是一種特殊注釋。

2.14一目了然的語句不加注釋。

2.15注釋的作用范圍可以為：定義、引用、條件分支以及一段代碼。

2.16注釋行數(shù)（不包括程序頭和函數(shù)頭說明部份）應(yīng)占總行數(shù)的1/5到1/3。

3.結(jié)構(gòu)化要求

3.1禁止出現(xiàn)兩條等價的支路。

3.2禁止GOTO語句。

3.3用IF語句來強(qiáng)調(diào)只執(zhí)行兩組語句中的一組。禁止ELSEGOTO和ELSERETURN,

3.4用CASE實(shí)現(xiàn)多路分支。

3.5避免從循環(huán)引出多個出口。

3.6函數(shù)只有一個出口。

3.7不使用條件賦值語句。

3.8避免不必要的分支。

3.9不要輕易用條件分支去替換邏輯表達(dá)式。

4.正確性與容錯性要求

4.1程序首先是正確，其次是優(yōu)美

4.2無法證明你的程序沒有錯誤，因此在編寫完一段程序后，應(yīng)先回頭檢查。

4.3改一個錯誤時可能產(chǎn)生新的錯誤，因此在修改前首先考慮對其它程序的影響。

4.4所有變量在調(diào)用前必須被初始化。

4.5對所有的用戶輸入，必須進(jìn)行合法性檢查。

4.6不要比較浮點(diǎn)數(shù)的相等，

如：10.0*0.1==1.0,不可靠

4.7程序與環(huán)境或狀態(tài)發(fā)生關(guān)系時，必須主動去處理發(fā)生的意外事件，如文件能否

邏輯鎖定、打印機(jī)是否聯(lián)機(jī)等。

4.8單元測試也是編程的一部份，提交聯(lián)調(diào)測試的程序必須通過單元測試。

5.可重用性要求

5.1重復(fù)使用的完成相對獨(dú)立功能的算法或代碼應(yīng)抽象為公共控件或類。

5.2公共控件或類應(yīng)考慮。。思想，減少外界聯(lián)系，考慮獨(dú)立性或封裝性。

5.3公共控件或類應(yīng)建立使用模板。

附：C++編程規(guī)范,delphi作相應(yīng)的參考

1適用范圍

本標(biāo)準(zhǔn)適用于利用VisulC++.BorlandC++進(jìn)行軟件程序開發(fā)的人員

.2變量命名

命名必須具有一定的實(shí)際意義,形式為xAbcFgh,x由變量類型確定,Abe、Fgh表示連續(xù)意

義字符串,如果連續(xù)意義字符串僅兩個，可都大寫.如0K.

具體例程：

BOOL類型bEnable;

ch*charchText

c*類對象cMain（對象實(shí)例）

h*Handle（句柄）hWnd

i*int

n*無符號整型

P*指針

sz,str*字符串

wWORD

x,y坐標(biāo)

Char或者TCHAR類型與WindowsAPI有直接聯(lián)系的用szAppName[10]形式否則用

FileName[10]形式，單個字符也可用小寫字母表示；

Int類型nCmdShow;

LONG類型1Param;

UINT類型uNotify;

DWORD類型dwStart;

PSTR類型pszTip;

LPSTR類型IpCmdLine

LPTSTR類型IpszClassName;

LPVOID類型IpReserved

WPARAM類型wParam,

LPARAM類型IParam

HWND類型hDIg;

HDC類型hDC;

HINSTANCE類型hlnstance

HANDLE類型hlnstance,

HICON類型hlcon;

intiTmp

floatfTmp

DWORDdw*

String,AnsiStringstr*

m_類成員變量m_nVal,m_bFlag

g_全局變量g_nMsg,g_bFlag

局部變量中可采用如下幾個通用變量：nTemp,nResult,1,J(一般用于循環(huán)變量)。

其他資源句柄同上

.3常量命名和宏定義

常量和宏定義必須具有一定的實(shí)際意義；

常量和宏定義在#include和函數(shù)定義之間；

常量和宏定義必須全部以大寫字母來撰寫，中間可根據(jù)意義的連續(xù)性用下劃線連接，每一

條定義的右側(cè)必須有一簡單的注釋，說明其作用；

資源名字定義格式：

菜單:IDM_XX或者CM_XX

位圖:IDB_XX

對話框:IDD_XX

字符串:IDS_XX

DLGINIT:DIALOG_XX

ICON:IDR_XX

.4函數(shù)命名

函數(shù)原型說明包括引用外來函數(shù)及內(nèi)部函數(shù)，外部引用必須在右側(cè)注明函數(shù)來源：模

塊名及文件名，如是內(nèi)部函數(shù)，只要注釋其定義文件名；

第一個字母必須使用大寫字母，要求用大小寫字母組合規(guī)范函數(shù)命名，必要時可用下劃線

間隔，示例如下：

voidUpdateDB_Tfgd(TRACK_NAME);file://ModuleName:r01/sdw.c

voidPrintTrackData(TRACK_NAME);file://ModuleName:r04/tern.c

voidImportantPoint(void);file://ModuleName:r01/sdw.c

voidShowChar(int,int,chtype);file://LocalModule

voidScrollUp_V(int,int);file://LocalModule

.5結(jié)構(gòu)體命名

結(jié)構(gòu)體類型命名必須全部用大寫字母,原則上前面以下劃線開始;結(jié)構(gòu)體變量命名必須用

大小寫字母組合，第一個字母必須使用大寫字母，必要時可用下劃線間隔。對于私有數(shù)

據(jù)區(qū)，必須注明其所屬的進(jìn)程。全局?jǐn)?shù)據(jù)定義只需注意其用途。

示例如下：

typedefstruct

charszProductName[20];

charszAuthor[20];

charszReleaseDate[16];

charszVersion[10];

unsignedlongMaxTables;

unsignedlongUsedTables;

}DBS_DATABASE;

DBS_DATABASEGdataBase;

6控件的命名：

用小寫前綴表示類別

用小寫前綴表示類別：

fm窗口

cmd按鈕

cobcombo.下拉式列表框

txt文本輸入框

lablabab標(biāo)簽

imgimage,圖象

picpicture

grdGrid,網(wǎng)格

scr滾動條

1st列表框

frmfram

7注釋

原則上注釋要求使用中文；

文件開始注釋內(nèi)容包括:公司名稱、版權(quán)、作者名稱、時間、模塊用途、背景介紹等，復(fù)

雜的算法需要加上流程說明；

函數(shù)注釋包括:輸入、輸出、函數(shù)描述、流程處理、全局變量、調(diào)用樣例等，復(fù)雜的函數(shù)

需要加上變量用途說明；

程序中注釋包括:修改時間和作者、方便理解的注釋等；

引用一：文件開頭的注釋模板

/******************************************************************

**文件名：

**Copyright(c)1998-1999叱******11*公司技術(shù)開發(fā)部

**創(chuàng)建人：

**日期：

**修改人：

**日期：

**描述：

**

**版本:

**

******************************************************************

引用二：函數(shù)開頭的注釋模板

/*****************************************************************

**函數(shù)名：

**輸入:a,b,c

**a—

**b—

**c---

**輸出:x--

**X為1,表示…

**x為0,表示…

**功能描述：

**全局變量：

**調(diào)用模塊：

**作者：

**日期：

**修改：

**日期：

**版本

****************************************************************/

引用三：程序中的注釋模板

/**I

/*注釋內(nèi)容7

/**/

8程序

a.程序編碼力求簡潔，結(jié)構(gòu)清晰，避免太多的分支結(jié)構(gòu)及太過于技巧性的程序，

盡量不采用遞歸模式。

b.編寫程序時，亦必須想好測試的方法，換句話說，”單元測試”的測試方案應(yīng)

在程序編寫時一并擬好。

c.注釋一定要與程序一致。

d.版本封存以后的修改一定要將老語句用/**/封閉，不能自行刪除或修改，并要

在文件及函數(shù)的修改記錄中加以記錄。

e.程序中每個block的開頭"{"及"}"必須對齊，嵌套的block每進(jìn)一套，

縮進(jìn)一個tab,TAB為4個空格,block類型包括if、for、while、do等關(guān)鍵字引出的。

f.對于比較大的函數(shù)，每個block和特殊的函數(shù)調(diào)用，都必須注明其功能，舉例如下

count.divisor=1193280/freq;//computethepropercount

OutByte((unsignedshort)67,(unsignedchar)182);//tell8253thata

countiscoming

OutByte((unsignedshort)66,count.c[0]);〃sendlow-orderbyte

OutByte((unsignedshort)66,count.c[l]);//sendhigh-orderbyte

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

bcb,delphi中的變量命名：

遵循匈牙利命名法，命

名必須有意義，制定如下規(guī)定

窗體：以大寫的W開始，如About版權(quán)窗體，命名為WAbout

文件：以大寫的F開始，如About版權(quán)窗體，文件命名為FAbout.cpp

按鈕(Button)：如退出按鈕，命名為btnExit

基類：加base標(biāo)記，如報表基類,窗體命名為：WBaseRep,文件命名為FBaseRep.cpp

轉(zhuǎn)貼

>1.在.h/.cpp的開頭應(yīng)有一段格式統(tǒng)一的說明，內(nèi)容包括：

>a.文件名(FileName)；

>b.創(chuàng)建人(Greater)；

>c.文件創(chuàng)建時間(Date)；

>d.簡短說明文件功能、用途(Comment)?

好習(xí)慣

>2.除非極其簡單，否則對函數(shù)應(yīng)有注釋說明。內(nèi)容包括：功能、入口/出口參數(shù)，必

要

>時還可有備注或補(bǔ)充說明。

還是好習(xí)慣

>3.每列代碼的長度推薦為80歹IJ,最長不得超過120歹U;折行以對齊為準(zhǔn).

太寬了，我的限制是60列，因?yàn)槲谋痉绞较缕聊灰还?0歹如果你用BC這一類的編輯

器，窗口邊框等又要占據(jù)一定空間，所以80列太寬

>4.循環(huán)、分支代碼，判斷條件與執(zhí)行代碼不得在同一行上。

很對

>5.指針的定義，*號既可以緊接類型，也可以在變量名之前。

>

>例：可寫做：int*pnsize;

>

>也可寫做：int*pnsize;

>

>但不得寫做：int*pnsize;

建議采用第二種，除非附加另外一條規(guī)定：一次只聲明一個變量，否則就會讓人混淆，

比如:

int*a,b;

看起來b好像也是個指針，其實(shí)不是。

>6.在類的成員函數(shù)內(nèi)調(diào)用非成員函數(shù)時，在非成員函數(shù)名前必須加上"::"。

這一條我倒覺得并不是必需的，我的看法是決不要讓你的類成員函數(shù)和全局函數(shù)的名稱

相同(或類似)

>7.函數(shù)入口參數(shù)有缺省值時，應(yīng)注釋說明。

>

>例：BOOLCWpsDib::PaintDIB(CDC*pDC,CRect&rc,

>intnBrightness,file:〃*=0*〃

>BOOLbGrayScalefile:〃*=FALSE*〃)

每個變量寫一行，必要時加上/*in,out*/注釋

>8.elseif必須寫在一行。

應(yīng)該盡量避免elseif這樣的結(jié)構(gòu)

>9.與，{'、'}'有關(guān)的各項(xiàng)規(guī)定：

>

>9.1應(yīng)獨(dú)占一行。在該行內(nèi)可有注釋。

>9.2'{'必須另起一行，'{'之后的代碼必須縮進(jìn)一個Tab。'{'與'}'必須在

同

>一列上。

>9.3在循環(huán)、分支之后若只有一行代碼，雖然可省略但不推薦這么

>做。若省略后可能引起歧義，則必須加上

持保留意見，因?yàn)镚NU的代碼規(guī)范是這樣的：

if(NULL==ptr)

(

//dosomethinghere

)

或者

if(NULL==ptr){

//dosomethinghere

)

爭論哪個更好并沒有意義，關(guān)鍵是統(tǒng)一，如果用VC當(dāng)然你的辦法最方便，可是如果你用

emacs或者vi,就不是這樣了。

>10.與空格有關(guān)的各項(xiàng)規(guī)定。

>

>10.1在所有兩目、三目運(yùn)算符的兩邊都必須有空格。在單目運(yùn)算符兩端不必空格。

但

>在等運(yùn)算符前后，及‘&'(取地址)、'*

>'(取值)等運(yùn)算符之后不得有空格。

>10.2for、while、if等關(guān)鍵詞之后應(yīng)有1個空格，再接'('，之后無空格；在結(jié)

尾

>的')’前不得有空格。

我認(rèn)為在括號兩端加空格并不是什么錯誤，尤其是在一個條件十分復(fù)雜的if語句里

>10.3調(diào)用函數(shù)、宏時，前后不得有空格。

>10.4類型強(qiáng)制轉(zhuǎn)換時，前后不得有空格

同上

>11.與縮進(jìn)有關(guān)的各項(xiàng)規(guī)定

>

>11.1縮進(jìn)以Tab為單位。1個Tab為4個空格

我認(rèn)為這個值應(yīng)該更大，我自己使用8個空格，如果你的代碼因?yàn)榭s進(jìn)幅度太大而導(dǎo)致

折行，那么幾乎可以肯定你的程序設(shè)計方案有問題。

>11.2下列情況，代碼縮進(jìn)一個Tab:

>1.函數(shù)體相對函數(shù)名及

>2.if、else、for>while,do等之后的代碼。

>3.一行之內(nèi)寫不下，折行之后的代碼，應(yīng)在合理的位置進(jìn)行折行。若有+-*/等

運(yùn)

>算符，則運(yùn)算符應(yīng)在上一行末尾，而不應(yīng)在下一行的行首。

這一條我反對，運(yùn)算符應(yīng)該放在下一行行首，以使人能清楚的知道這一行是續(xù)上一行

的，比如

if(something

&&somethingelse

&&otherthings)

如果寫做

if(something&&

somethingelse&&

otherthings)

反而看不清楚

>11,3下列情況，不必縮進(jìn)：switch之后的case、default?

編程規(guī)范與范例

目錄

1排版6

2注釋11

3標(biāo)識符命名18

4可讀性20

5變量、結(jié)構(gòu)22

6函數(shù)、過程28

7可測性36

8程序效率40

9質(zhì)量保證44

10代碼編輯、編譯、審查50

11代碼測試、維護(hù)52

12宏53

1排版

1-1:程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個。

說明：對于由開發(fā)工具自動生成的代碼可以有不一致。

1-2：相對獨(dú)立的程序塊之間、變量說明之后必須加空行。

示例：如下例子不符合規(guī)范。

if(!valid_ni(ni))

(

...〃programcode

)

repssnind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

應(yīng)如下書寫

if(!valid_ni(ni))

(

...//programcode

repssnjnd=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

1-3：較長的語句(>80字符)要分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，

操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。

示例：

perm_count_msg.head.len=N07_T0_STAT_PERM_C0UNT_LEN

+STAT_SIZE_PER_FRAM*sizeof(_UL);

act_task_table[frame__id*STAT_IASK_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_fIag=((taskno<MAX_ACT_TASK_NUMBER)

&&(n7stat_stat_item_vaIid(statjtem))

&&(act_task_table[taskno].result_data!=0));

1-4：循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分，長表達(dá)式要在

低優(yōu)先級操作符處劃分新行，操作符放在新行之首。

示例：

if((taskno<max_act_task_number)

&&(n7stat__stat_item_valid(statjtem)))

...//programcode

for(i=0,j=0;(i<BufferKeyword[word_index].word_length)

&&(j<NewKeyword.wordJength);i++,j++)

(

...//programcode

)

for(i=0,j=0;

(i<first_word_length)&&(j<second_word_length);

i++,j++)

(

...//programcode

)

&supl;1-5：若函數(shù)或過程中的參數(shù)較長，則要進(jìn)行適當(dāng)?shù)膭澐帧?/p>

示例：

n7stat_str_compare((BYTE*)&stat_object,

(BYTE*)&(act_task_table[taskno].stat_object)z

sizeof(_STAT_OBJECT));

n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER

+index,stat_object);

&supl;1-6：不允許把多個短語句寫在一行中，即一行只寫一條語句。

示例：如下例子不符合規(guī)范。

rect.length=0;rect.width=0;

應(yīng)如下書寫

rect.length=0;

rect.width=0;

1-7：if、for、do、while、case^switch>default等語句自占一行,且if、for^do、while等

語句的執(zhí)行語句部分無論多少都要加括號｛｝。

示例：如下例子不符合規(guī)范。

if(pUserCR==NULL)return;

應(yīng)如下書寫：

if(pUserCR==NULL)

(

return;

)

1-8：對齊只使用空格鍵，不使用TAB鍵。

說明：以免用不同的編輯器閱讀程序時，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不

整齊，不要使用BC作為編輯器合版本，因?yàn)锽C會自動將8個空格變?yōu)橐粋€TAB鍵，因此

使用BC合入的版本大多會將縮進(jìn)變亂。

1-9：函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格，case

語句下的情況處理語句也要遵從語句縮進(jìn)要求。

1-10：程序塊的分界符(如C/C++語言的大括號'{‘和'}')應(yīng)各獨(dú)占一行并且位于同一列，

同時與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及

if、for、do、while^switchscase語句中的程序都要采用如上的縮進(jìn)方式。

示例：如下例子不符合規(guī)范。

for(...){

...//programcode

if(…)

(

...//programcode

)

voidexample_fun(void)

(

...//programcode

}

應(yīng)如下書寫。

for(...)

(

...//programcode

if(…)

(

...//programcode

voidexample_fun(void)

(

...//programcode

)

1-11：在兩個以上的關(guān)鍵字、變量、常量進(jìn)行對等操作時，它們之間的操作符之前、之后或

者前后要加空格；進(jìn)行非對等操作時;如果是關(guān)系密切的立即操作符(如一＞),后不應(yīng)加空

格。

說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。

由于留空格所產(chǎn)生的清晰性是相對的，所以，在已經(jīng)非常清晰的語句中沒有必要再留空格，

如果語句已足夠清晰則括號內(nèi)側(cè)(即左括號后面和右括號前面)不需要加空格，多重括號間不

必加空格，因?yàn)樵贑/C++語言中括號已經(jīng)是最清晰的標(biāo)志了。

在長語句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。給操

作符留空格時不要連續(xù)留兩個以上空格。

示例:

(1)逗號、分號只在后面加空格。

inta,b,c;

⑵比較操作符,賦值操作符”二”、算術(shù)操作符"邏輯操作符"&&"、，&“,位域

操作符“<<“、”八”等雙目操作符的前后加空格。

if(current_time>=MAX_TIME_VALUE)

a=b+c;

a*=2;

a=bA2;

(3)"!"、(地址運(yùn)算符)等單目操作符前后不加空格。

*p='a';//內(nèi)容操作"*"與內(nèi)容之間

flag=lisEmpty;//非操作"!"與內(nèi)容之間

P=&mem;//地址操作"&"與內(nèi)容之間

i++;〃"++","」與內(nèi)容之間

(4)"->"、前后不加空格。

p->id=pid;〃"->"指針前后不加空格

⑸if、for、while、switch等與后面的括號間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。

if(a>=b&&c>d)

1-1：一行程序以小于80字符為宜，不要寫得過長。

2注釋

2-1：一般情況下，源程序有效注釋量必須在20%以上。

說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能

太少，注釋語言必須準(zhǔn)確、易懂、簡潔。

2-2：說明性文件(如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等)頭部應(yīng)進(jìn)

行注釋，注釋必須列出：版權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的

關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明。

示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包

含在內(nèi)。

/*************************************************

Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.

Filename://文件名

Author:Version:Date://作者、版本及完成日期

Description://用于詳細(xì)說明此程序文件完成的主要功能，與其他模塊

//或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控

//制、順序、獨(dú)立或依賴等關(guān)系

Others://其它內(nèi)容的說明

FunctionList:〃主要函數(shù)列表，每條記錄應(yīng)包括函數(shù)名及功能簡要說明

1.....

History:〃修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改

//者及修改內(nèi)容簡述

1.Date:

Author:

Modification:

*************************************************/

2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說明、版本號、生成日期、作者、模塊目的/功能、

主要函數(shù)及其功能、修改日志等。

示例：下面這段源文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包

含在內(nèi)。

***********************************************************

Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.

FileName:test.cpp

Author:Version:Date:

Description://模塊描述

Version://版本信息

FunctionList://主要函數(shù)及其功能

1.-------

History://歷史修改記錄

<author><time><version><desc>

David96/10/121.0buildthismoudle

***********************************************************/

說明：Description一項(xiàng)描述本文件的內(nèi)容、功能、內(nèi)部各部分之間的關(guān)系及本文件與其它文

件關(guān)系等。History是修改歷史記錄列表，每條修改記錄應(yīng)包括修改日期、修改者及修改內(nèi)

容簡述。

2-4：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用

關(guān)系（函數(shù)、表）等。

示例：下面這段函數(shù)的注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在

內(nèi)。

/*************************************************

Function://函數(shù)名稱

Description://函數(shù)功能、性能等的描述

Calls://被本函數(shù)調(diào)用的函數(shù)清單

CalledBy:〃調(diào)用本函數(shù)的函數(shù)清單

TableAccessed://被訪問的表（此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序）

TableUpdated://被修改的表（此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序）

Input://輸入?yún)?shù)說明，包括每個參數(shù)的作

//用、取值說明及參數(shù)間關(guān)系。

Output://對輸出參數(shù)的說明。

Return://函數(shù)返回值的說明

Others://其它說明

*************************************************/

2-5：邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再

有用的注釋要刪除。

2-6：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。

說明：錯誤的注釋不但無益反而有害。

規(guī)則2.7：避免在注釋中使用縮寫，特別是非常用縮寫。

說明：在使用縮寫時或之前，應(yīng)對縮寫進(jìn)行必要的說明。

2-8：注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）

相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。

示例：如下例子不符合規(guī)范。

例1：

/*getreplicatesubsystemindexandnetindicator*/

repssnjnd=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

例2：

repssnjnd=ssn_data[index].repssr）Jndex;

repssn_ni=ssn_data[index].ni;

/*getreplicatesubsystemindexandnetindicator*/

應(yīng)如下書寫

/*getreplicatesubsystemindexandnetindicator*/

repssnjnd=ssn_data[index].repssnjndex;

repssn_ni=ssn_data[index].ni;

2-9：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須

加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。

示例：

/*activestatistictasknumber*/

ttdefineMAX_ACT_TASK_NUMBER1000

ftdefineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/

2-10：數(shù)據(jù)結(jié)構(gòu)聲明（包括數(shù)組、結(jié)構(gòu)、類、枚舉等），如果其命名不是充分自注釋的，必須

加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的

注釋放在此域的右方。

示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。

/*seepinterfacewithseepuserprimitivemessagename*/

enumSCCP_USER_PRIMITIVE

{

N_UNITDATA_IND,/*seepnotifyseepuserunitdatacome*/

N_NOTICE_IND,/*seepnotifyusertheNo.7networkcannot*/

/*transmissionthismessage*/

N_UNITDATA_REQ,/*seepuser'sunitdatatransmissionrequest*/

}；

2-11：全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及

存取時注意事項(xiàng)等的說明。

示例：

/*TheErrorCodewhenSCCPtranslate*/

/*GlobalTitlefailure,asfollows*/〃變量作用、含義

/*0-SUCCESS1-GTTableerror*/

/*2—GTerrorOthers—nouse*///變量取值范圍

/*onlyfunctionSCCPTranslate()in*/

/*thismodualcanmodifyit,andother*/

/*modulecanvisititthroughcall*/

/*thefunctionGetGTTransErrorCode()*///使用方法

BYTEg_GTTranErrorCode;

2-12：注釋與所描述內(nèi)容進(jìn)行同樣的縮排。

說明：可使程序排版整齊，并方便注釋的閱讀與理解。

示例：如下例子，排版不整齊，閱讀稍感不方便。

voidexample__fun(void)

(

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

)

應(yīng)改為如下布局。

voidexample_fun(void)

(

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

2-13：將注釋與其上面的代碼用空行隔開。

示例：如下例子，顯得代碼過于緊湊。

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

應(yīng)如下書寫

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

2-14：對變量的定義和分支語句(條件分支、循環(huán)語句等)必須編寫注釋。

說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護(hù)人員來說，良好的注釋幫助

更好的理解程序，有時甚至優(yōu)于看設(shè)計文檔。

2-15：對于switch語句下的case語句，如果因?yàn)樘厥馇闆r需要處理完一個case后進(jìn)入下一

個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋。

說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。

示例(注意斜體加粗部分)：

caseCMD_UP:

ProcessUpO;

break;

caseCMD_DOWN:

ProcessDown();

break;

caseCMD__FWD:

ProcessFwd();

if(...)

(

break;

)

else

(

ProcessCFW_B();//nowjumpintocaseCMD__A

)

caseCMD_A:

ProcessA();

break;

caseCMD_B:

ProcessB();

break;

caseCMD_C:

ProcessC();

break;

caseCMD_D:

ProcessD();

break;

2-1：避免在一行代碼或表達(dá)式的中間插入注釋。

說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。

2-2：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成

為自注釋的。

說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。

2-3：在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。

說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者

理解代碼，防止沒必要的重復(fù)注釋信息。

示例：如下注釋意義不大。

/*ifreceive_flagisTRUE*/

if(receive_flag)

而如下的注釋則給出了額外有用的信息。

/*ifmtpreceiveamessagefromlinks*/

if(receive_flag)

2-4：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。

說明：當(dāng)代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。

示例：參見如下例子。

if(-)

(

//programcode

while(index<MAXJNDEX)

(

//programcode

}/*endofwhile(index<MAXJNDEX)*///指明該條while語句結(jié)束

}/*endofif(...)*/〃指明是哪條if語句結(jié)束

2-5：注釋格式盡量統(tǒng)一,建議使用"/*……*/”.

2-6：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用

中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。

說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護(hù)人員的考慮，建議使用中

文。

3標(biāo)識符命名

3-1：標(biāo)識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解

的縮寫，避免使人產(chǎn)生誤解。

說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮

寫；一些單詞有大家公認(rèn)的縮寫。

示例：如下單詞的縮寫能夠被大家基本認(rèn)可。

temp可縮寫為tmp;

flag可縮寫為fig;

statistic可縮寫為stat;

increment可縮寫為inc;

message可縮寫為msg;

3-2：命名中若使用特殊約定或縮寫，則要有注釋說明。

說明：應(yīng)該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行

必要的注釋說明。

3-3：自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化。

說明：個人的命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即

命名規(guī)則中沒有規(guī)定到的地方才可有個人命名風(fēng)格）。

3-4：對于變量命名，禁止取單個字符（如i、j、k...）,建議除了要有具體含義外，還能表明

其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。

說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j）,而編譯時

又檢查不出來，有可能為了這個小小的錯誤而花費(fèi)大量的查錯時間。

示例：下面所示的局部變量名的定義方法可以借鑒。

intliv_Width

其變量名解釋如下：

I局部變量（Local）（其它：g全局變量（Global）...）

i數(shù)據(jù)類型（Interger）

v變量（Variable）（其它：c常量（Const）...）

Width變量含義

這樣可以防止局部變量與全局變量重名。

3-5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用UNIX的

全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特

殊標(biāo)識如標(biāo)識成員變量或全局變量的0!_和8_,其后加上大小寫混排的方式是允許的。

示例：AddJJser不允許，add_user、AddUser、m_AddUser允許。

3-1：除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識符。

示例：如下命名，使人產(chǎn)生疑惑。

^define_EXAMPLE_O_TEST_

ttdefine_EXAMPLE_1_TEST_

voidset_sls00（BYTEsis）;

應(yīng)改為有意義的單詞命名

#define_EXAMPLE_UNIT__TEST_

#define_EXAMPLE_ASSERT_TEST_

voidset_udt_msg_sls（BYTEsis）;

3-2：在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，

防止編譯、鏈接時產(chǎn)生沖突。

說明：對接口部分的標(biāo)識符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量

之前加上“模塊”標(biāo)識等。

3-3：用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。

說明：下面是一些在軟件中常用的反義詞組。

add/removebegin/endcreate/destroy

insert/deletefirst/lastget/release

increment/decrementput/get

add/deletelock/unlockopen/close

min/maxold/newstart/stop

next/previoussource/targetshow/hide

send/receivesource/destination

cut/pasteup/down

示例：

intmin_sum;

intmax_sum;

intadd_user(BYTE*user__name);

intdelete_user(BYTE*user_name);

3-4：除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用一EXAMPLE_TEST_之類以下劃線開始和

結(jié)尾的定義。

4可讀性

4-1:注意運(yùn)算符的優(yōu)先級，并用括號明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級。

說明：防止閱讀程序時產(chǎn)生誤解，防止因默認(rèn)的優(yōu)先級與設(shè)計思想不符而導(dǎo)致程序出錯。

示例：下列語句中的表達(dá)式

word=(high?8)|low(1)

if((a|b)&&(a&c))(2)

if((a|b)<(c&d))(3)

如果書寫為

high?8|low

a|b&&a&c

a|b<c&d

由于

high?8|low=(high?8)|low,

a|b&&a&c=(a|b)&&(a&c),

(1)(2)不會出錯，但語句不易理解；

a|b<c&d=a|(b<c)&d,⑶造成了判斷條件出錯。

4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識來替代。涉及物理狀態(tài)或者含有物理意義

的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替。

示例：如下的程序可讀性差。

if(Trunk[index].trunk_state==0)

(

Trunk[index].trunk_state=1;

...//programcode

)

應(yīng)改為如下形式。

#defineTRUNKJDLEO

#defineTRUNK_BUSYl

if(Trunk[index].trunk_state==TRUNK_IDLE)

(

Trunk[index].trunk_state=TRUNK_BUSY;

...//programcode

4-1：源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。

說明：便于程序閱讀和查找。

示例：以下代碼布局不太合理。

rect.length=10;

char_poi=str;

rect.width=5;

若按如下形式書寫，可能更清晰一些。

rect.length=10;

rect.width=5;//矩形的長與寬關(guān)系較密切，放在一起。

char_poi=str;

4-2：不要使用難懂的技巧性很高的語句，除非很有必要時。

說明：高技巧語句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于算法。

示例：如下表達(dá)式，考慮不周就可能出問題，也較難理解。

*stat_poi+++=1;

*++stat_poi+=1;

應(yīng)分別改為如下。

*stat_poi+=1;

stat_poi++;//此二語句功能相當(dāng)于"*stat_poi+++=1;"

++stat_poi;

*stat_poi+=1;//此二語句功能相當(dāng)于"*++stat_poi+=1;"

5變量、結(jié)構(gòu)

5-1:去掉沒必要的公共變量。

說明：公共變量是增大模塊間耦合的原因之一，故應(yīng)減少沒必要的公共變量以降低模塊間的

耦合度。

5-2：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。

說明：在對變量聲明的同時，應(yīng)對其含義、作用及取值范圍進(jìn)行注釋說明，同時若有必要還

應(yīng)說明與其它變量的關(guān)系。

5-3：明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系，如訪問、修改及創(chuàng)建等。

說明：明確過程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測試、系統(tǒng)聯(lián)調(diào)以及

代碼維護(hù)等。這種關(guān)系的說明可在注釋或文檔中描述。

示例：在源文件中，可按如下注釋形式說明。

RELATIONSystem_lnitlnput_RecPrint_RecStat_Score

StudentCreateModifyAccessAccess

ScoreCreateModifyAccessAccess,Modify

注:RELATION為操作關(guān)系;System_lnit>lnput_Rec、Print_Rec、Stat_Score為四個不同的函

數(shù)；Student、Score為兩個全局變量；Create表示創(chuàng)建，Modify表示修改，Access表示訪問。

其中，函數(shù)lnput_Rec、Stat_Score都可修改變量Score,故此變量將引起函數(shù)間較大的耦合，

并可能增加代碼測試、維護(hù)的難度。

5-4：當(dāng)向公共變量傳遞數(shù)據(jù)時，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。

說明：對公共變量賦值時，若有必要應(yīng)進(jìn)行合法性檢查，以提高代碼的可靠性、穩(wěn)定性。

5-5：防止局部變量與公共變量同名。

說明：若使用了較好的命名規(guī)則，那么此問題可自動消除。

5-6：嚴(yán)禁使用未經(jīng)初始化的變量作為右值。

說明：特別是在C/C++中引用未經(jīng)賦值的指針，經(jīng)常會引起系統(tǒng)崩潰。

5-1：構(gòu)造僅有一個模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問的公共變量，

防止多個不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。

說明：降低公共變量耦合度。

5-2：使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)系

密切的變量。

說明：使用標(biāo)準(zhǔn)的數(shù)據(jù)類型，有利于程序的移植。

示例：如下例子(在DOS下BC3.1環(huán)境中)，在移植時可能產(chǎn)生問題。

voidmain()

(

registerintindex;//寄存器變量

_AX=0x4000;//_AX是BC3.1提供的寄存器“偽變量”

...//programcode

}

5-3：結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象。

說明：設(shè)計結(jié)構(gòu)時應(yīng)力爭使結(jié)構(gòu)代表一種現(xiàn)實(shí)事務(wù)的抽象，而不是同時代表多種。結(jié)構(gòu)中的

各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放

到同一結(jié)構(gòu)中。

示例：如下結(jié)構(gòu)不太清晰、合理。

typedefstructSTUDENT_STRU

(

unsignedcharname[8];/*student'sname*/

unsignedcharage;/*student'sage*/

unsignedcharsex;/*student'ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedchar

teacher_name[8];/*thestudentteacher'sname*/

unisgnedchar

teacher_sex;/*histeachersex*/

}STUDENT;

若改為如下，可能更合理些。

typedefstructTEACHER_STRU

{

unsignedcharname[8];/*teachername*/

unisgnedcharsex;/*teachersex,asfollows*/

/*0-FEMALE;1-MALE*/

}TEACHER;

typedefstructSTUDENT_STRU

unsignedcharname[8];/*student'sname*/

unsignedcharage;/*student'sage*/

unsignedcharsex;/*student'ssex,asfollows*/

/*0-FEMALE;1-MALE*/

unsignedintteacherjnd;/*histeacherindex*/

}STUDENT;

5-4：不要設(shè)計面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)。

說明：面面俱到、靈活的數(shù)據(jù)結(jié)構(gòu)反而容易引起誤解和操作困難。

5-5：不同結(jié)構(gòu)間的關(guān)系不要過于復(fù)雜。

說明：若兩個結(jié)構(gòu)間關(guān)系較復(fù)雜、密切，那么應(yīng)合為一個結(jié)構(gòu)。

示例：如下兩個結(jié)構(gòu)的構(gòu)造不合理。

typedefstructPERSON_ONE_STRU

unsignedcharname[8];

unsignedcharaddr[40];

unsignedcharsex;

unsignedcharcity[15];

}PERSON_ONE;

typedefstructPERSON_TWO_STRU

(

unsignedcharname[8];

unsignedcharage;

unsignedchartel;

}PERSON_TWO;

由于兩個結(jié)構(gòu)都是描述同一事物的，那么不如合成一個結(jié)構(gòu)。

typedefstructPERSON_STRU

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSON;

5-6：結(jié)構(gòu)中元素的個數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個數(shù)過多可考慮依據(jù)某種原則把元素組成不

同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個數(shù)。

說明：增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。

示例：假如認(rèn)為如上的一PERSON結(jié)構(gòu)元素過多，那么可如下對之劃分。

typedefstructPERSON_BASE_INFO_STRU

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

}PERSON_BASE_INFO;

typedefstructPERSON_ADDRESS_STRU

(

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSON_ADDRESS;

typedefstructPERSON_STRU

(

PERSON_BASE_INFOperson_base;

PERSON_ADDRESSperson_addr;

}PERSON;

5-7：仔細(xì)設(shè)計結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引

起誤用現(xiàn)象。

說明：合理排列結(jié)構(gòu)中元素順序，可節(jié)省空間并增加可理解性。

示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。

typedefstructEXAMPLE_STRU

(

unsignedintvalid:1;

PERSONperson;

unsignedintset_flg:1;

}EXAMPLE;

若改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。

typedefstructEXAMPLE_STRU

(

unsignedintvalid:1;

unsignedintset_flg:1;

PERSONperson;

}EXAMPLE;

5-8：結(jié)構(gòu)的設(shè)計要盡量考慮向前兼容和以后的版本升級，并為某些未來可能的應(yīng)用保留余

地(如預(yù)留一些空間等)。

說明：軟件向前兼容的特性，是軟件產(chǎn)品是否成功的重要標(biāo)志之一。如果要想使產(chǎn)品具有較

好的前向兼容，那么在產(chǎn)品設(shè)計之初就應(yīng)為以后版本升級保留一定余地，并且在產(chǎn)品升級時

必須考慮前一版本的各種特性。

5-9：留心具體語言及編譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細(xì)節(jié)。

說明：如在C語言中，static局部變量將在內(nèi)存“數(shù)據(jù)區(qū)”中生成，而非static局部變量將

在“堆?！敝猩?。這些細(xì)節(jié)對程序質(zhì)量的保證非常重要。

5-10：編程時，要注意數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)換。

說明：當(dāng)進(jìn)行數(shù)據(jù)類型強(qiáng)制轉(zhuǎn)換時，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而

這些細(xì)節(jié)若考慮不周，就很有可能留下隱患。

5-11：對編譯系統(tǒng)默認(rèn)的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認(rèn)識。

示例：如下賦值，多數(shù)編譯器不產(chǎn)生告警，但值的含義還是稍有變化。

charchr;

unsignedshortintexam;

chr=-1;

exam=chr;//編譯器不產(chǎn)生告警，此時exam為OxFFFF?

5-12：盡量減少沒有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換。

5-13：合理地設(shè)計數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進(jìn)行不必要的類型轉(zhuǎn)換。

5-14：對自定義數(shù)據(jù)類型進(jìn)行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意

其命名方式在同一產(chǎn)品中的統(tǒng)一。

說明：使用自定義類型，可以彌補(bǔ)編程語言提供類型少、信息量不足的缺點(diǎn)，并能使程序清

晰、簡潔。

示例：可參考