VC程式設計規範-程式員們都應該這樣寫代碼

原作者姓名 作者：wl3000wlnew

讀者評分 10 評分次數 3

正文

VC程式設計規範-程式員們都應該這樣寫代碼

作者：wl3000wlnew

基本要求

1.1 程式結構清析，簡單易懂，單個函數的程式行數不得超過100行。

1.2 打算幹什麼，要簡單，直接了當，代碼精簡，避免垃圾程式。

1.3 盡量使用标準庫函數和公共函數。

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

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

2.可讀性要求

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

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

2.3 每個源程式檔案，都有檔案頭說明，說明規格見規範。

2.4 每個函數，都有函數頭說明，說明規格見規範。

2.5 主要變量（結構、聯合、類或對象）定義或引用時，注釋能反映其含義。

2.7 常量定義（DEFINE）有相應說明。

2.8 處理過程的每個階段都有相關注釋說明。

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

2.10 利用縮進來顯示程式的邏輯結構，縮進量一緻并以Tab鍵為機關，定義Tab為 6個

位元組。

2.11 循環、分支層次不要超過五層。

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

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

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

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

2.16 注釋行數（不包括程式頭和函數頭說明部份）應占總行數的 1/5 到 1/3 。

3. 結構化要求

3.1 禁止出現兩條等價的支路。

3.2 禁止GOTO語句。

3.3 用 IF 語句來強調隻執行兩組語句中的一組。禁止 ELSE GOTO 和 ELSE RETURN。

3.4 用 CASE 實作多路分支。

3.5 避免從循環引出多個出口。

3.6 函數隻有一個出口。

3.7 不使用條件指派語句。

3.8 避免不必要的分支。

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

4. 正确性與容錯性要求

4.1 程式首先是正确，其次是優美

4.2 無法證明你的程式沒有錯誤，是以在編寫完一段程式後，應先回頭檢查。

4.3 改一個錯誤時可能産生新的錯誤，是以在修改前首先考慮對其它程式的影響。

4.4 所有變量在調用前必須被初始化。

4.5 對所有的使用者輸入，必須進行合法性檢查。

4.6 不要比較浮點數的相等，

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

4.7 程式與環境或狀态發生關系時，必須主動去處理發生的意外事件，如檔案能否

邏輯鎖定、列印機是否聯機等。

4.8 單元測試也是程式設計的一部份，送出聯調測試的程式必須通過單元測試。

5. 可重用性要求

5.1 重複使用的完成相對獨立功能的算法或代碼應抽象為公共控件或類。

5.2 公共控件或類應考慮OO思想，減少外界聯系，考慮獨立性或封裝性。

5.3 公共控件或類應建立使用模闆。

附：C＋＋ 程式設計規範,delphi作相應的參考

.1适用範圍

本标準适用于利用Visul C++ ,Borland C++進行軟體程式開發的人員.。

.2變量命名

命名必須具有一定的實際意義,形式為xAbcFgh,x由變量類型确定,Abc、Fgh表示連續意

義字元串,如果連續意義字元串僅兩個,可都大寫.如OK.

具體例程:

BOOL類型 bEnable;

ch * char chText

c * 類對象 cMain（對象執行個體）

h * Handle（句柄） hWnd

i * int

n * 無符号整型

p * 指針

sz,str * 字元串

w WORD

x,y 坐标

Char或者TCHAR類型 與Windows API有直接聯系的用szAppName[10]形式否則用

FileName[10]形式,單個字元也可用小寫字母表示;

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;

int iTmp

float fTmp

DWORD dw*

String , AnsiString str *

m_ 類成員變量 m_nVal, m_bFlag

g_ 全局變量 g_nMsg, g_bFlag

局部變量中可采用如下幾個通用變量：nTemp，nResult，I，J（一般用于循環變量）。

其他資源句柄同上

.3常量命名和宏定義

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

常量和宏定義在#include和函數定義之間;

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

條定義的右側必須有一簡單的注釋,說明其作用;

資源名字定義格式:

菜單:IDM_XX或者CM_XX

位圖:IDB_XX

對話框:IDD_XX

字元串:IDS_XX

DLGINIT:DIALOG_XX

ICON:IDR_XX

.4函數命名

函數原型說明包括引用外來函數及内部函數，外部引用必須在右側注明函數來源： 模

塊名及檔案名, 如是内部函數，隻要注釋其定義檔案名;

第一個字母必須使用大寫字母,要求用大小寫字母組合規範函數命名,必要時可用下劃線

間隔,示例如下：

void UpdateDB_Tfgd (TRACK_NAME); //Module Name :r01/sdw.c

void PrintTrackData (TRACK_NAME); //Module Name :r04/tern.c

void ImportantPoint (void); //Module Name :r01/sdw.c

void ShowChar (int , int , chtype); //Local Module

void ScrollUp_V (int , int); //Local Module

.5結構體命名

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

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

據區，必須注明其所屬的程序。全局資料定義隻需注意其用途。

示例如下：

typedef struct

{

char szProductName[20];

char szAuthor[20];

char szReleaseDate[16];

char szVersion[10];

unsigned long MaxTables;

unsigned long UsedTables;

}DBS_DATABASE;

DBS_DATABASE GdataBase;

6 控件的命名：

用小寫字首表示類别

用小寫字首表示類别：

fm 視窗

cmd 按鈕

cob combo，下拉式清單框

txt 文本輸入框

lab labal，标簽

img image，圖象

pic picture

grd Grid，網格

scr 滾動條

lst 清單框

frm fram

7注釋

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

檔案開始注釋内容包括:公司名稱、版權、作者名稱、時間、子產品用途、背景介紹等,複

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

函數注釋包括:輸入、輸出、函數描述、流程處理、全局變量、調用樣例等,複雜的函數

需要加上變量用途說明;

程式中注釋包括:修改時間和作者、友善了解的注釋等;

引用一: 檔案開頭的注釋模闆

引用二: 函數開頭的注釋模闆

引用三: 程式中的注釋模闆

8 程式

a. 程式編碼力求簡潔，結構清晰，避免太多的分支結構及太過于技巧性的程式，

盡量不采用遞歸模式。

b. 編寫程式時，亦必須想好測試的方法，換句話說，”單元測試” 的測試方案應

在程式編寫時一并拟好。

c. 注釋一定要與程式一緻。

d. 版本封存以後的修改一定要将老語句用 封閉，不能自行删除或修改,并要

在檔案及函數的修改記錄中加以記錄。

e. 程式中每個block 的開頭 ”{" 及 "}” 必須對齊，嵌套的block 每進一套，

縮進一個tab，TAB 為4個空格,block類型包括if、for、while、do等關鍵字引出的。

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

：

count.divisor = 1193280 / freq; // compute the proper count

OutByte((unsigned short)67, (unsigned char)182); // tell 8253 that a

count is coming

OutByte((unsigned short)66, count. c[0]); // send low-order byte

OutByte((unsigned short)66, count. c[1]); // send high-order byte

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

bcb，delphi中的變量命名：

遵循匈牙利命名法，命

名必須有意義，制定如下規定

窗體： 以大寫的W開始，如About版權窗體， 命名為WAbout

檔案：以大寫的F開始，如About版權窗體，檔案命名為FAbout.cpp

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

……

基類： 加base标記，如報表基類,窗體命名為：WBaseRep, 檔案命名為FBaseRep.cpp

正文完