基于交流電動(dòng)機(jī)動(dòng)態(tài)模型的直

湖南科技大學(xué)

信息與電氣工程學(xué)院

《課程設(shè)計(jì)報(bào)告》

題目：基于交流電動(dòng)機(jī)動(dòng)態(tài)模型的直

接轉(zhuǎn)矩控制系統(tǒng)的仿真與設(shè)計(jì)

專業(yè)：電氣工程其自動(dòng)化

班級(jí)：三

姓名：

學(xué)號(hào)：

指導(dǎo)教師：吳新開

任務(wù)書

題目

基于交流電動(dòng)機(jī)動(dòng)態(tài)模型的直接轉(zhuǎn)矩控制系統(tǒng)的仿真與設(shè)計(jì)

時(shí)間安排

2013年12月22號(hào)-2014年1月3號(hào)

目的：

應(yīng)用所學(xué)的交、直流調(diào)速系統(tǒng)的基本知識(shí)與工程設(shè)計(jì)方法，結(jié)合生產(chǎn)實(shí)際，確定系統(tǒng)的性能指標(biāo)與實(shí)現(xiàn)方案，進(jìn)行運(yùn)動(dòng)控制系統(tǒng)的初步設(shè)計(jì)。

應(yīng)用計(jì)算機(jī)仿真技術(shù)，通過在MATLAB軟件上建立運(yùn)動(dòng)控制系統(tǒng)的數(shù)學(xué)模型，對(duì)控制系統(tǒng)進(jìn)行性能仿真研究，掌握系統(tǒng)參數(shù)對(duì)系統(tǒng)性能的影響。

在原理設(shè)計(jì)與仿真研究的基礎(chǔ)上，應(yīng)用PROTEL進(jìn)行控制系統(tǒng)的印制板的設(shè)計(jì)，為畢業(yè)設(shè)計(jì)的綜合運(yùn)用奠定堅(jiān)實(shí)的基礎(chǔ)。

要求：

1.

應(yīng)詳細(xì)敘述控制系統(tǒng)各部件的方案選擇

2.

應(yīng)詳細(xì)敘述控制系統(tǒng)的設(shè)計(jì)過程及參數(shù)選擇的理由.

3.

設(shè)計(jì)報(bào)告應(yīng)包括控制系統(tǒng)原理圖一份,并附系統(tǒng)工作原理說明.

4.

仿真結(jié)果曲線圖要有性能分析.

5.

設(shè)計(jì)報(bào)告應(yīng)有自己的設(shè)計(jì)感想.

總體方案實(shí)現(xiàn)：

1.直接轉(zhuǎn)矩控制系統(tǒng)設(shè)計(jì)。

2.磁鏈的調(diào)節(jié)通過磁鏈滯環(huán)比較器實(shí)現(xiàn)。

3.轉(zhuǎn)矩調(diào)節(jié)器的任務(wù)是實(shí)現(xiàn)對(duì)轉(zhuǎn)矩的直接控制。

4.異步電動(dòng)機(jī)直接轉(zhuǎn)矩控制系統(tǒng)的仿真。

5.總結(jié)與展望。

指導(dǎo)教師評(píng)語(yǔ)：

評(píng)分等級(jí)：（）

指導(dǎo)教師簽名：

異步電動(dòng)機(jī)直接轉(zhuǎn)矩控制系統(tǒng)的基本理論

DTC系統(tǒng)只需檢測(cè)電壓、電流信號(hào)，運(yùn)用空間矢量的思想，

在定子坐標(biāo)系下就可以實(shí)現(xiàn)對(duì)交流電動(dòng)機(jī)磁鏈和轉(zhuǎn)矩的計(jì)算

與控制[4-5].如圖1所示是異步電動(dòng)機(jī)直接轉(zhuǎn)矩控制系統(tǒng)的基本

組成.通過對(duì)轉(zhuǎn)矩和磁鏈的控制，產(chǎn)生轉(zhuǎn)矩開關(guān)信號(hào)、磁鏈開關(guān)

信號(hào)和扇區(qū)信號(hào)，與最優(yōu)開關(guān)矢量表對(duì)照，輸出逆變器控制信

號(hào)，實(shí)現(xiàn)對(duì)電動(dòng)機(jī)轉(zhuǎn)矩的直接控制.

一、設(shè)計(jì)參數(shù)

額定輸出功率10KW；

定子繞組額定線電壓380V；

定子繞組額定相電流15A;

定子繞組每相電阻0.2歐姆；

定子繞組接線形式Y(jié)；

轉(zhuǎn)子額定轉(zhuǎn)速980rpm;

轉(zhuǎn)子形式:鼠籠式；

轉(zhuǎn)子每相折算電阻:3歐姆；

轉(zhuǎn)子折算后額定電流30A；

額定功率因數(shù)：0.75；

電機(jī)機(jī)電時(shí)間常數(shù)1S;

電樞允許過載系數(shù)1.5；

二、設(shè)計(jì)目的

應(yīng)用所學(xué)的交、直流調(diào)速系統(tǒng)的基本知識(shí)與工程設(shè)計(jì)方法，結(jié)合生產(chǎn)實(shí)際，確定系統(tǒng)的性能指標(biāo)與實(shí)現(xiàn)方案，進(jìn)行運(yùn)動(dòng)控制系統(tǒng)的初步設(shè)計(jì)。

應(yīng)用計(jì)算機(jī)仿真技術(shù)，通過在MATLAB軟件上建立運(yùn)動(dòng)控制系統(tǒng)的數(shù)學(xué)模型，對(duì)控制系統(tǒng)進(jìn)行性能仿真研究，掌握系統(tǒng)參數(shù)對(duì)系統(tǒng)性能的影響。

在原理設(shè)計(jì)與仿真研究的基礎(chǔ)上，應(yīng)用PROTEL進(jìn)行控制系統(tǒng)的印制板的設(shè)計(jì)，為畢業(yè)設(shè)計(jì)的綜合運(yùn)用奠定堅(jiān)實(shí)的基礎(chǔ)。

三、方案的論證

直接轉(zhuǎn)矩控制系統(tǒng)的組成：

直接轉(zhuǎn)矩控制充分利用電壓型逆變器的開關(guān)特點(diǎn)，通過不斷變化電壓狀態(tài)使定子磁鏈軌跡為六邊形或近似圓形，并通過零電壓矢量的穿插調(diào)節(jié)來(lái)改變轉(zhuǎn)差頻率，以控制電機(jī)的轉(zhuǎn)矩與磁鏈的變化，從而控制異步電動(dòng)機(jī)的磁鏈和轉(zhuǎn)矩按要求快速變化。直接轉(zhuǎn)矩控制系統(tǒng)調(diào)速的主題就是在于調(diào)節(jié)電動(dòng)機(jī)的磁鏈和轉(zhuǎn)矩的變化，電動(dòng)機(jī)的輸出轉(zhuǎn)矩完全是按照輸入轉(zhuǎn)矩的設(shè)定。

(l)磁鏈、轉(zhuǎn)矩觀測(cè)器:由電流、電壓的采樣值經(jīng)過3/2變化按照電機(jī)數(shù)學(xué)模型計(jì)算出異步電機(jī)的定子磁鏈和轉(zhuǎn)矩;

(2)磁鏈調(diào)節(jié)器:為了控制定子磁鏈在給定值的附近變化，直接轉(zhuǎn)矩控制系統(tǒng)采用兩點(diǎn)式控制，輸出磁鏈控制信號(hào);

(3)轉(zhuǎn)矩調(diào)節(jié)器:利用轉(zhuǎn)速調(diào)節(jié)器輸出的給定轉(zhuǎn)矩，也是采用兩點(diǎn)式滯環(huán)控制，輸出轉(zhuǎn)矩控制信號(hào)，直接控制電機(jī)的轉(zhuǎn)矩;

(4)開關(guān)狀態(tài)選擇單元:根據(jù)定子磁鏈和轉(zhuǎn)矩的控制信號(hào)以及定子磁鏈位置，輸出合適的開關(guān)狀態(tài)來(lái)控制逆變器驅(qū)動(dòng)電機(jī)穩(wěn)定運(yùn)行。

直接轉(zhuǎn)矩控制系統(tǒng)是建立在靜止定子坐標(biāo)系下的，首先異步電機(jī)定子相電壓、相電流的采樣值經(jīng)3/2坐標(biāo)變換，得到坐標(biāo)下的分量，再按照異步電機(jī)的定子磁鏈和轉(zhuǎn)矩模型計(jì)算出實(shí)際轉(zhuǎn)矩和定子磁鏈的兩個(gè)分量、，這樣就可以計(jì)算出定子磁鏈幅值和磁鏈位置。將測(cè)量得到實(shí)際轉(zhuǎn)速和給定轉(zhuǎn)速輸入到轉(zhuǎn)速調(diào)節(jié)器，轉(zhuǎn)速調(diào)節(jié)器根據(jù)給定轉(zhuǎn)速和實(shí)際轉(zhuǎn)速的差值輸出給定轉(zhuǎn)矩。將給定轉(zhuǎn)矩和送入轉(zhuǎn)矩調(diào)節(jié)器，得到轉(zhuǎn)矩控制信號(hào)，磁鏈調(diào)節(jié)器根據(jù)給定子磁鏈幅值和轉(zhuǎn)子磁鏈幅值的差值輸出磁鏈控制信號(hào)。最后開關(guān)狀態(tài)選擇單元根據(jù)磁鏈控制信號(hào)、轉(zhuǎn)矩控制信號(hào)和磁鏈位置，查逆變器開關(guān)狀態(tài)表，輸出正確合理的開關(guān)狀態(tài)來(lái)控制逆變器驅(qū)動(dòng)電機(jī)正確運(yùn)行。

3.1磁鏈調(diào)節(jié)

磁鏈的調(diào)節(jié)通過磁鏈滯環(huán)比較器實(shí)現(xiàn)。滯環(huán)比較器如圖3-2所示。磁鏈誤差為，將誤差進(jìn)行滯環(huán)比較，當(dāng)誤差超過允許值就進(jìn)行電壓切換，使誤差控制在滯環(huán)寬度內(nèi)。調(diào)制規(guī)則為:

當(dāng)時(shí)，，此時(shí)選擇電壓矢量使增加;當(dāng)時(shí)，此時(shí)選擇擇電壓矢量使得減小;當(dāng)時(shí)，不變，此時(shí)電壓矢量不變。

圖3-2磁鏈滯環(huán)調(diào)節(jié)器

磁鏈位置檢測(cè)單元:

為了檢測(cè)定子磁鏈的位置，將坐標(biāo)系分為六個(gè)區(qū)域：

（3-4）

其中N=1,2,3,4,5,6，每個(gè)區(qū)域占角度，定子磁鏈在第n區(qū)域，我們就稱其在n區(qū)域。轉(zhuǎn)矩調(diào)節(jié)器的結(jié)構(gòu)與磁鏈調(diào)節(jié)器的結(jié)構(gòu)一樣，也采用滯環(huán)比較器(見圖3-3)輸入量為轉(zhuǎn)矩給定值及轉(zhuǎn)矩觀測(cè)值，輸出量為，為轉(zhuǎn)矩滯環(huán)范圍。

3.2轉(zhuǎn)矩調(diào)節(jié)

轉(zhuǎn)矩調(diào)節(jié)器的任務(wù)是實(shí)現(xiàn)對(duì)轉(zhuǎn)矩的直接控制。為了控制轉(zhuǎn)矩，轉(zhuǎn)矩調(diào)節(jié)器必須具備兩個(gè)功能:(l)轉(zhuǎn)矩調(diào)節(jié)器直接調(diào)節(jié)轉(zhuǎn)矩;(2)在調(diào)節(jié)轉(zhuǎn)矩的同時(shí)，控制定子磁鏈的旋轉(zhuǎn)方向，以加強(qiáng)轉(zhuǎn)矩的調(diào)節(jié)。通過電壓矢量來(lái)控制定子磁鏈的旋轉(zhuǎn)速度，從而改變定、轉(zhuǎn)子磁鏈?zhǔn)噶恐g的夾角，達(dá)到控制電機(jī)轉(zhuǎn)矩的目的，用定轉(zhuǎn)子磁鏈?zhǔn)噶糠e來(lái)表達(dá)異步電機(jī)的電磁轉(zhuǎn)矩。

在實(shí)際運(yùn)行中要確保要保證定子磁鏈?zhǔn)噶康姆禐槎ㄖ?，使電?dòng)機(jī)的鐵芯得到充分的利用；轉(zhuǎn)子磁鏈?zhǔn)噶康姆涤呻妱?dòng)機(jī)帶動(dòng)的負(fù)載決定。可以通過改變磁通角的大小來(lái)改變電動(dòng)機(jī)轉(zhuǎn)矩的大小。通過加載有效空間電壓矢量，改變空間電壓矢量，使空間電壓矢量的幅值更合理，定子磁鏈的轉(zhuǎn)速大于轉(zhuǎn)子磁鏈轉(zhuǎn)速的大小使磁通角增大，從而增加轉(zhuǎn)矩；加載零電壓矢量，控制定子磁鏈停止運(yùn)行使磁通角變小，從而使轉(zhuǎn)矩減小。

轉(zhuǎn)矩調(diào)節(jié)器的控制規(guī)律為:

逆時(shí)針旋轉(zhuǎn)時(shí)：

若時(shí)，則；

若時(shí)，則；

若時(shí)，則保持不變。

順時(shí)針旋轉(zhuǎn)時(shí)：

若時(shí)，則;

若時(shí)，則；

若時(shí)，則保持不變

圖3-2轉(zhuǎn)矩滯環(huán)調(diào)節(jié)器

調(diào)試過程及結(jié)果分析

4.1直接轉(zhuǎn)矩控制系統(tǒng)仿真模型

由第二章知兩相靜止坐標(biāo)系下的異步電機(jī)的電壓方程:

(4-1)

磁鏈方程：

4.2電壓和電流的坐標(biāo)變換模塊

電壓的三相坐標(biāo)/兩相坐標(biāo)的變換關(guān)系如式(4-3)所示：

（4-3）

電壓2/3的變換關(guān)系：

圖4-2電壓坐標(biāo)3/2變換仿真模塊

圖表4-3電流2/3坐標(biāo)變換仿真模塊

4.3磁鏈、轉(zhuǎn)矩控制模型

磁鏈控制采用兩點(diǎn)式調(diào)節(jié)、轉(zhuǎn)矩控制采用三點(diǎn)式調(diào)節(jié)

圖4-4磁鏈控制器

圖4-5轉(zhuǎn)矩控制器

4.4磁鏈幅值計(jì)算與區(qū)域判定模型

圖4-6磁鏈幅值，磁鏈當(dāng)前扇區(qū)判斷模型

磁鏈幅值計(jì)算采用matlab函數(shù)，其表達(dá)式為Sqrt(u(1)2+u(2)2)。磁鏈當(dāng)前所在扇區(qū)判定選用simulink的s一Funetion來(lái)實(shí)現(xiàn)。

4.3異步電動(dòng)機(jī)直接轉(zhuǎn)矩控制系統(tǒng)的仿真參數(shù)與結(jié)果

仿真電機(jī)參數(shù)如下:額定功率為10KW，額定電壓為380V，額定轉(zhuǎn)速為980r/min，定子電阻為0.2。，轉(zhuǎn)子電阻為3。頻率為工頻50赫茲，取摩擦系數(shù)為0。

系統(tǒng)給定值如下:給定磁鏈為0.5，給定轉(zhuǎn)矩為30N·M，負(fù)載轉(zhuǎn)矩為0N*M，給定直流電壓為308V；給定磁鏈容差為0.01Wb，給定轉(zhuǎn)矩容差為0.1N*M。

圖4-8直接轉(zhuǎn)矩控制系統(tǒng)的磁鏈軌跡

圖4-9轉(zhuǎn)矩響應(yīng)波形

圖4-10直接轉(zhuǎn)矩控制系統(tǒng)的三相定子電流波形

圖4-11直接轉(zhuǎn)矩控制系統(tǒng)的定子電壓波形

圖4-12電動(dòng)機(jī)相電壓波形

通過圖可以看出，采用直接轉(zhuǎn)矩控制時(shí)，電機(jī)運(yùn)行平穩(wěn)，輸出轉(zhuǎn)矩脈動(dòng)小，電機(jī)啟動(dòng)快，系統(tǒng)的轉(zhuǎn)矩響應(yīng)都比較快。同時(shí)轉(zhuǎn)矩的脈動(dòng)從波形上看頻率很高，對(duì)轉(zhuǎn)矩變化跟隨比較好。說明直接轉(zhuǎn)矩控制系統(tǒng)的動(dòng)態(tài)和穩(wěn)態(tài)時(shí)的性能優(yōu)良。

五、設(shè)計(jì)及調(diào)試中的體會(huì)

在做設(shè)計(jì)的時(shí)候我對(duì)異步電機(jī)數(shù)學(xué)模型做了一個(gè)簡(jiǎn)單的了解，了解了定子轉(zhuǎn)子的磁鏈的模型，查閱了大量的資料了解了直接轉(zhuǎn)矩控制系統(tǒng)在運(yùn)動(dòng)控制中的優(yōu)點(diǎn)與缺點(diǎn)。我利用Matlab軟件對(duì)直接轉(zhuǎn)矩控制系統(tǒng)進(jìn)行仿真，驗(yàn)證了直接轉(zhuǎn)矩控制理論的正確性。

六、體會(huì)和建議

隨著現(xiàn)代科技的進(jìn)步在研究直接轉(zhuǎn)矩控制的時(shí)間加入現(xiàn)代的最新科技是提升生產(chǎn)力的必然選擇。直接轉(zhuǎn)矩控制中定子電阻的觀測(cè)、無(wú)速度傳感器理論、電壓矢量細(xì)化等研究的不斷深入，與神經(jīng)網(wǎng)絡(luò)、模糊控制等新技術(shù)的融合，以及研究將直接轉(zhuǎn)矩控制技術(shù)應(yīng)用于同步電機(jī)的趨勢(shì)，使得直接轉(zhuǎn)矩控制在理論上日趨成熟。相信在不久的將來(lái)直接轉(zhuǎn)矩控制系統(tǒng)必將占據(jù)交流電機(jī)控制的主導(dǎo)地位。

參考文獻(xiàn)

交流調(diào)速系統(tǒng)仿真模型

主電路

參考書目：

[1]陳伯時(shí)主編.電力拖動(dòng)自動(dòng)控制系統(tǒng)[M].北京：機(jī)械工業(yè)出版社，2003

[2]馮垛生主編.交流調(diào)速系統(tǒng).北京:機(jī)械工業(yè)出版社2000

[3]陳治明.電力電子器件[M].北京：機(jī)械工業(yè)出版社，1992

[4]王兆安.電力電子變流技術(shù)[M].北京：機(jī)械工業(yè)出版社，2003

[5]張明勛.電力電子設(shè)備和應(yīng)用手冊(cè)[M].北京：機(jī)械工業(yè)出版社，1992

[6]顧繩谷.電機(jī)及拖動(dòng)基礎(chǔ)下冊(cè)[M].北京:機(jī)械工業(yè)出版社2000

附錄資料：不需要的可以自行刪除

C語(yǔ)言編程規(guī)范(僅供參考)

1.基本要求

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

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

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

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

1.5使用括號(hào)以避免二義性。

2.可讀性要求

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

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

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

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

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

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

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

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

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

字節(jié)。

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

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

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

2.14一目了然的語(yǔ)句不加注釋。

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

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

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

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

3.2禁止GOTO語(yǔ)句。

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

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

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

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

3.7不使用條件賦值語(yǔ)句。

3.8避免不必要的分支。

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

4.正確性與容錯(cuò)性要求

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

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

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

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

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

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

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

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

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

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

5.可重用性要求

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

5.2公共控件或類應(yīng)考慮OO思想，減少外界聯(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由變量類型確定,Abc、Fgh表示連續(xù)意

義字符串,如果連續(xù)意義字符串僅兩個(gè),可都大寫.如OK.

具體例程:

BOOL類型bEnable;

ch*charchText

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

h*Handle（句柄）hWnd

i*int

n*無(wú)符號(hào)整型

p*指針

sz,str*字符串

wWORD

x,y坐標(biāo)

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

FileName[10]形式,單個(gè)字符也可用小寫字母表示;

Int類型nCmdShow;

LONG類型lParam;

UINT類型uNotify;

DWORD類型dwStart;

PSTR類型pszTip;

LPSTR類型lpCmdLine

LPTSTR類型lpszClassName;

LPVOID類型lpReserved

WPARAM類型wParam,

LPARAM類型lParam

HWND類型hDlg;

HDC類型hDC;

HINSTANCE類型hInstance

HANDLE類型hInstance,

HICON類型hIcon;

intiTmp

floatfTmp

DWORDdw*

String,AnsiStringstr*

m_類成員變量m_nVal,m_bFlag

g_全局變量g_nMsg,g_bFlag

局部變量中可采用如下幾個(gè)通用變量：nTemp，nResult，I，J（一般用于循環(huán)變量）。

其他資源句柄同上

.3常量命名和宏定義

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

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

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

條定義的右側(cè)必須有一簡(jiǎn)單的注釋,說明其作用;

資源名字定義格式:

菜單:IDM_XX或者CM_XX

位圖:IDB_XX

對(duì)話框:IDD_XX

字符串:IDS_XX

DLGINIT:DIALOG_XX

ICON:IDR_XX

.4函數(shù)命名

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

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

第一個(gè)字母必須使用大寫字母,要求用大小寫字母組合規(guī)范函數(shù)命名,必要時(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)體變量命名必須用

大小寫字母組合，第一個(gè)字母必須使用大寫字母,必要時(shí)可用下劃線間隔。對(duì)于私有數(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文本輸入框

lablabal，標(biāo)簽

imgimage，圖象

picpicture

grdGrid，網(wǎng)格

scr滾動(dòng)條

lst列表框

frmfram

7注釋

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

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

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

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

需要加上變量用途說明;

程序中注釋包括:修改時(shí)間和作者、方便理解的注釋等;

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

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

**文件名:

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

**創(chuàng)建人:

**日期:

**修改人:

**日期:

**描述:

**

**版本:

**--------------------------------------------------------------------------

---

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

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

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

**函數(shù)名:

**輸入:a,b,c

**a---

**b---

**c---

**輸出:x---

**x為1,表示...

**x為0,表示...

**功能描述:

**全局變量:

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

**作者:

**日期:

**修改:

**日期:

**版本

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

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

/*----------------------------------------------------------*/

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

/*----------------------------------------------------------*/

8程序

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

盡量不采用遞歸模式。

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

在程序編寫時(shí)一并擬好。

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

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

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

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

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

f.對(duì)于比較大的函數(shù)，每個(gè)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[1]);//sendhigh-orderbyte

×××××××××××××××××××××××××××××××××××××××

bcb，delphi中的變量命名：

遵循匈牙利命名法，命

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

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

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

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

……

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

轉(zhuǎn)貼

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

>a.文件名(FileName)；

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

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

>d.簡(jiǎn)短說明文件功能、用途(Comment)。

好習(xí)慣

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

要

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

還是好習(xí)慣

>3.每列代碼的長(zhǎng)度推薦為80列，最長(zhǎng)不得超過120列；折行以對(duì)齊為準(zhǔn)。

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

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

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

很對(duì)

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

>

>例：可寫做：int*pnsize;

>

>也可寫做：int*pnsize;

>

>但不得寫做：int*pnsize;

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

比如：

int*a,b;

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

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

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

相同（或類似）

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

>

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

>intnBrightness,file://*=0*//

>BOOLbGrayScalefile://*=FALSE*//)

每個(gè)變量寫一行，必要時(shí)加上/*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)一個(gè)Tab。‘{’與‘}’必須在

同

>一列上。

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

>做。若省略后可能引起歧義，則必須加上‘{’、‘}’。

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

if(NULL==ptr)

{

//dosomethinghere

}

或者

if(NULL==ptr){

//dosomethinghere

}

爭(zhēng)論哪個(gè)更好并沒有意義，關(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個(gè)空格，再接‘(’，之后無(wú)空格；在結(jié)

尾

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

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

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

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

同上

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

>

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

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

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

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

>1.函數(shù)體相對(duì)函數(shù)名及'{'、'}'。

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

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

運(yùn)

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

這一條我反對(duì)，運(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)識(shí)符命名18

4可讀性20

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

6函數(shù)、過程28

7可測(cè)性36

8程序效率40

9質(zhì)量保證44

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

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

12宏53

1排版

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

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

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

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

if(!valid_ni(ni))

{

...//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

應(yīng)如下書寫

if(!valid_ni(ni))

{

...//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

1-3：較長(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[frame_id*STAT_TASK_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_flag=((taskno<MAX_ACT_TASK_NUMBER)

&&(n7stat_stat_item_valid(stat_item))

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

1-4：循環(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)))

{

...//programcode

}

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

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

{

...//programcode

}

for(i=0,j=0;

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

i++,j++)

{

...//programcode

}

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

示例：

n7stat_str_compare((BYTE*)&stat_object,

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

sizeof(_STAT_OBJECT));

n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER

+index,stat_object);

¹1-6：不允許把多個(gè)短語(yǔ)句寫在一行中，即一行只寫一條語(yǔ)句。

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

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

應(yīng)如下書寫

rect.length=0;

rect.width=0;

1-7：if、for、do、while、case、switch、default等語(yǔ)句自占一行，且if、for、do、while等語(yǔ)句的執(zhí)行語(yǔ)句部分無(wú)論多少都要加括號(hào){}。

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

if(pUserCR==NULL)return;

應(yīng)如下書寫：

if(pUserCR==NULL)

{

return;

}

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

說明：以免用不同的編輯器閱讀程序時(shí)，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因?yàn)锽C會(huì)自動(dòng)將8個(gè)空格變?yōu)橐粋€(gè)TAB鍵，因此使用BC合入的版本大多會(huì)將縮進(jìn)變亂。

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

1-10：程序塊的分界符（如C/C++語(yǔ)言的大括號(hào)‘{’和‘}’）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。

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

for(...){

...//programcode

}

if(...)

{

...//programcode

}

voidexample_fun(void)

{

...//programcode

}

應(yīng)如下書寫。

for(...)

{

...//programcode

}

if(...)

{

...//programcode

}

voidexample_fun(void)

{

...//programcode

}

1-11：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－>），后不應(yīng)加空格。

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

由于留空格所產(chǎn)生的清晰性是相對(duì)的，所以，在已經(jīng)非常清晰的語(yǔ)句中沒有必要再留空格，如果語(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)只在后面加空格。

inta,b,c;

(2)比較操作符,賦值操作符"="、"+="，算術(shù)操作符"+"、"%"，邏輯操作符"&&"、"&"，位域操作符"<<"、"^"等雙目操作符的前后加空格。

if(current_time>=MAX_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)

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

2注釋

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

說明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔。

2-2：說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要說明。

示例：下面這段頭文件的頭注釋比較標(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ù)名及功能簡(jiǎn)要說明

1.....

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

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

1.Date:

Author:

Modification:

2....

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

2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(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)容簡(jiǎn)述。

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)僅對(duì)于牽扯到數(shù)據(jù)庫(kù)操作的程序）

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

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

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

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

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

Others://其它說明

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

2-5：邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。

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

說明：錯(cuò)誤的注釋不但無(wú)益反而有害。

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

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

2-8：注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語(yǔ)句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。

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

例1：

/*getreplicatesubsystemindexandnetindicator*/

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

例2：

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

/*getreplicatesubsystemindexandnetindicator*/

應(yīng)如下書寫

/*getreplicatesubsystemindexandnetindicator*/

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

2-9：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。

示例：

/*activestatistictasknumber*/

#defineMAX_ACT_TASK_NUMBER1000

#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/

2-10：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方。

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

/*sccpinterfacewithsccpuserprimitivemessagename*/

enumSCCP_USER_PRIMITIVE

{

N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/

N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/

/*transmissionthismessage*/

N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/

};

2-11：全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(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：對(duì)變量的定義和分支語(yǔ)句（條件分支、循環(huán)語(yǔ)句等）必須編寫注釋。

說明：這些語(yǔ)句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對(duì)于維護(hù)人員來(lái)說，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。

2-15：對(duì)于switch語(yǔ)句下的case語(yǔ)句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語(yǔ)句處理完、下一個(gè)case語(yǔ)句前加上明確的注釋。

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

示例（注意斜體加粗部分）：

caseCMD_UP:

ProcessUp();

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：通過對(duì)函數(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)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。

示例：參見如下例子。

if(...)

{

//programcode

while(index<MAX_INDEX)

{

//programcode

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

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

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

2-6：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語(yǔ)言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。

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

3標(biāo)識(shí)符命名

3-1：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。

說明：較短的單詞可通過去掉“元音”形成縮寫；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。

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

temp可縮寫為tmp;

flag可縮寫為flg;

statistic可縮寫為stat;

increment可縮寫為inc;

message可縮寫為msg;

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

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

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

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

3-4：對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。

說明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫成j），而編譯時(shí)又檢查不出來(lái)，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。

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

intliv_Width

其變量名解釋如下：

l局部變量（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)識(shí)如標(biāo)識(shí)成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的。

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

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

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

#define_EXAMPLE_0_TEST_

#define_EXAMPLE_1_TEST_

voidset_sls00(BYTEsls);

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

#define_EXAMPLE_UNIT_TEST_

#define_EXAMPLE_ASSERT_TEST_

voidset_udt_msg_sls(BYTEsls);

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

說明：對(duì)接口部分的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識(shí)等。

3-3：用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(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)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。

說明：防止閱讀程序時(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|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)不會(huì)出錯(cuò)，但語(yǔ)句不易理解；

a|b<c&d=a|（b<c）&d，(3)造成了判斷條件出錯(cuò)。

4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來(lái)替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來(lái)代替。

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

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

{

Trunk[index].trunk_state=1;

...//programcode

}

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

#defineTRUNK_IDLE0

#defineTRUNK_BUSY1

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;//矩形的長(zhǎng)與寬關(guān)系較密切，放在一起。

char_poi=str;

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

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

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

*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;”

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

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

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

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

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

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

說明：明確過程操作變量的關(guān)系后，將有利于程序的進(jìn)一步優(yōu)化、單元測(cè)試、系統(tǒng)聯(lián)調(diào)以及代碼維護(hù)等。這種關(guān)系的說明可在注釋或文檔中描述。

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

RELATIONSystem_InitInput_RecPrint_RecStat_Score

StudentCreateModifyAccessAccess

ScoreCreateModifyAccessAccess,Modify

注：RELATION為操作關(guān)系；System_Init、Input_Rec、Print_Rec、Stat_Score為四個(gè)不同的函數(shù)；Student、Score為兩個(gè)全局變量；Create表示創(chuàng)建，Modify表示修改，Access表示訪問。

其中，函數(shù)Input_Rec、Stat_Score都可修改變量Score，故此變量將引起函數(shù)間較大的耦合，并可能增加代碼測(cè)試、維護(hù)的難度。

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

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

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

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

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

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

5-1：構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問的公共變量，防止多個(gè)不同模塊或函數(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)境中），在移植時(shí)可能產(chǎn)生問題。

voidmain()

{

registerintindex;//寄存器變量

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

...//programcode

}

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

說明：設(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)把描述沒有關(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*/

unsignedintteacher_ind;/*histeacherindex*/

}STUDENT;

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

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

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

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

示例：如下兩個(gè)結(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;

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

typedefstructPERSON_STRU

{

unsignedcharname[8];

unsignedcharage;

unsignedcharsex;

unsignedcharaddr[40];

unsignedcharcity[15];

unsignedchartel;

}PERSON;

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

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

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

typedefstructPERSON_BASE_INFO_STRU

{

unsignedcha