1.1編寫目的
在軟件開發過程中，編碼的工作量是相當大的，同壹項目參與編程的人可能有各自編程的經驗和習慣，不同風格的程序代碼使維護工作變得復雜和困難。為了提高代碼的可讀性、系統的穩定性及降低維護和升級的成本，特編寫本規範以統壹各開發人員的編程工作。
1.2 適用對象
本規範適用於所有開發人員，包括應用程序、網頁及數據庫開發人員，及有關的程序測試人員。
1.3 引用標準
GB/T 11457 軟件工程術語
GB 8566 計算機軟件開發規範
GB 8567 計算機軟件產品開發文件編制指南
2．編寫要求
2.1壹般代碼規則
可讀性原則，這是評價程序質量的首選指標，寧可不要壹些技巧也要保證程序的易讀特性，不要因過分追求技巧而犧牲程序的可讀性。 功能獨立性原則。每壹程序塊只完成壹個獨立的功能，反過來，每壹獨立的功能只在壹程序塊內完成，盡量低耦合、高內聚。 提示說明應當簡短且避免產生歧義。 提示或警告信息應當具有向導性，能準確告訴用戶錯誤原因及恢復方法。提示和警告對話框應當使用標準規範。 快捷鍵的定義必須符合用戶操作習慣。 程序需要長時間處理或等待時，應當顯示進度條並提示用戶等待。 壹些敏感操作，如刪除等操作在執行前必須提示用戶確認。2.2變量、函數、過程、控件等命名規則
2.2.1 變量命名
變量命名采用[作用範圍][數據類型][自定義名稱]規則定義，並遵循匈牙利命名法。要求看到變量名就能直觀的看出其範圍和數據類型。
匈牙利命名規則：a Array 數組
b BOOL (int) 布爾(整數)
by Unsigned Char (Byte) 無符號字符(字節)
c Char 字符(字節)
cb Count of bytes 字節數
cr Color reference value 顏色(參考)值
cx Count of x (Short) x的集合(短整數)
dw DWORD (unsigned long) 雙字(無符號長整數)
f Flags (usually multiple bit values) 標誌(壹般是有多位的數值)
fn Function 函數
g_ global 全局的
h Handle 句柄
i Integer 整數
l Long 長整數
lp Long pointer 長指針
m_ Data member of a class 壹個類的數據成員
n Short int 短整數
p Pointer 指針
s String 字符串
sz Zero terminated String 以0結尾的字符串
tm Text metric 文本規則
u Unsigned int 無符號整數
ul Unsigned long (ULONG) 無符號長整數
w WORD (unsigned short) 無符號短整數
x,y x, y coordinates (short) 坐標值/短整數
v void 空
作用範圍：範圍 前綴 例子
全局作用域 g_ g_Servers
成員變量 m_ m_pDoc
局部作用域 無 strName
數據類型VC常用前綴列表
前綴 類型 描述 例子
ch char 8位字符 chGrade
ch TCHAR 16位UNICODE類型字符 chName
b BOOL 布爾變量 bEnabled
n int 整型（其大小由操作系統決定） nLength
n UINT 無符號整型（其大小由操作系統決定） nLength
w WORD 16位無符號整型 wPos
l LONG 32位有符號整型 lOffset
dw DWORD 32位無符號整型 dwRange
p * 內存模塊指針，指針變量 pDoc
l p FAR* 長指針 lpDoc
lpsz LPSTR 32位字符串指針 lpszName
lpsz LPCSTR 32位常量字符串指針 lpszName
lpsz LPCTSTR 32位UNICODE類型常量指針 lpszName
h handle Windows對象句柄 hWnd
lpfn (*fn)() 回調函數指針 Callback Far pointer to
CALLBACK function lpfnAbort
2.2.2 函數、過程命名
函數或過程名的主體應該使用大小寫混合形式，並且應該足夠長以描述它的作用。而且，函數名應該以壹個動詞起首，如 InitNameArray 或 CloseDialog。對於頻繁使用的或長的項，推薦使用標準縮略語以使名稱的長度合理化。壹般來說，超過 32 個字符的變量名在 VGA 顯示器上讀起來就困難了。當使用縮略語時，要確保它們在整個應用程序中的壹致性。在壹個工程中，如果壹會兒使用 Cnt， 壹會兒使用 Count，將導致不必要的混淆。
對於自行編寫的函數，若是系統關鍵函數，則須在函數實現部分的上方標明該函數的信息，格式如下：
//======================================================
// 函 數 名：InsureHasOutputInfo
// 功能描述：確保有適當的輸出信息
// 輸入參數：nProductID:相應的產品ID
// 輸出參數：void
// 創建日期：00-2-21
// 修改日期：00-2-21
// 作 者：***
// 附加說明：
//======================================================
2.2.3 用戶定義類型
在壹項有許多用戶定義類型的大工程中，常常有必要給每種類型壹個它自己的三個字符的前綴。如果這些前綴是以 "u" 開始的，那麽當用壹個用戶定義類型來工作時，快速識別這些類型是很容易的。例如，ucli 可以被用來作為壹個用戶定義的客戶類型變量的前綴。
註：對於非通用的變量，請在定義時加以註釋說明，變量定義盡可能放在最開始處。
2.2.4 控件命名
應該用壹致的前綴來命名對象，使人們容易識別對象的類型。
VC常用宏定義命名列表
前綴 符號類型 符號例子 範圍
IDR_ 標識多個資源***享的類型 IDR_MAINFRAME 1~0x6FFF
IDD_ 對話框資源（Dialog） IDD_SPELL_CHECK 1~ 0x6FFF
HIDD_ 基於對話框的上下文幫助 HIDD_SPELL_CHECK 0x20001~0x26FF
IDB_ 位圖資源（Bitmap） IDB_COMPANY_LOGO 1~0x6FFF
IDC_ 光標資源（Cursor） IDC_PENCIL 1~0x6FFF
IDI_ 圖標資源（Icon） IDI_NOTEPAD 1~0x6FFF
ID_、IDM_ 工具欄或菜單欄的命令項 ID_TOOLS_SPELLING 0x8000~0xDFFF
HID_ 命令上下文幫助 HID_TOOLS_SPELLING 0x18000~0x1DFFF
IDP_ 消息框提示文字資源 IDP_INVALID_PARTNO 8~0xDFFF
HIDP_ 消息框上下文幫助 HIDP_INVALID_PARTNO 0x30008~0x3DFFF
IDS_ 字符串資源（String） IDS_COPYRIGHT 1~0x7FFF
IDC_ 對話框內的控制資源 IDC_RECALC 8~0xDFFF
2.3源代碼規則
2.3.1風格約定：采用縮進的格式保存程序的層次結構。要求能直觀的看出循環、判斷等層次結構。
每壹個嵌套的函數塊，使用壹個TAB縮進（可以設定為4個空格），大括號必須放在條件語句的下壹行，單獨成壹行，便於匹對反大括號應該在單獨的壹行，在大多數情況下反擴號應有註釋內容。舉例如下：
if(condition1)
{
while(condition2)
{
…..
…..
}//end while(condition2)
}//end if (condition1)
或者
if(condition1){
while(condition2){
….
….
}//end while(condition2)
}//end if(conditionl)
2.3.2在操作符的前後必須使用空格。
2.3.3在分隔數組下標和函數參數的逗號後面必須添上空格。
2.3.4嚴禁使用go to 語句。
2.3.5對數據庫操作只能使用標準SQL語句，關鍵字必須使用大寫（如SELECT、WHERE等），數據元素（表、字段、視圖等）必須按照數據字典書寫。
2.3.6程序代碼中要有足夠的容錯處理功能。
對可能發生的異常統壹采用C++拋出格式：
try
{
//可能引發異常的代碼
throw t; //手工拋出異常
}
catch(type_1 e) // type_1為類型定義符、如int、CException、_com_error
{
// type_1類型異常處理
}
catch(type_2 e)
{
// type_2類型異常處理
}
2.3.7程序代碼結構必須層次清楚，適當使用空行分段。
2.3.8工程的版本控制要嚴格，版本格式為.me.ae.yy.mmdd，其中：[me]表示主版本號；[ae]表示輔版本號；[yy.mmdd]表示版本建立日期。高版本盡量兼容低版本的用法、數據或協議。
2．4文件的命名規則
2.4.1根據系統設計所規定的結構，建立相應的文件夾，根據需要建立子文件夾。
2.4.2文件夾和文件的名稱應盡量能夠表達其意義，盡量使用英文命名，絕對不能漢字。
2.4.3文件名稱壹般采用“xxx_yyy.ext”格式，xxx(3-4個字母)表示分類，yyy(字母數自定)表示操作 (如 “ /example/exp_edit.htm ”)
\
我從公司文檔拷貝的！妳自己看看對妳有沒有用！