軟件開發(fā)過程文檔 VC編碼規(guī)約

1、計算機源代碼編寫規(guī)范(VC編碼規(guī)范)編 號：MPDK/ZY-18-2007修 改 號：0發(fā) 放 號：發(fā)布時間：2007-06-28實施時間：2007-06-28編 制：批 準：VC編碼規(guī)范1 目的 規(guī)定科大恒星公司的VC編程規(guī)約。2 適用范圍適合公司所有的VC編程項目。3 規(guī)范內(nèi)容3.1工程文件開發(fā)工作常常和別的從公司合作進行，各個公司的開發(fā)環(huán)境個不相同，為了使開發(fā)的工程可以簡單的意志，請遵守以下的約定。包含文件，庫文件必須在DSP或makefile中明確書寫。DSP或makefile必須使用相對路徑，禁止使用絕對路徑。不要使包含文件依賴于VC的環(huán)境設(shè)定（不要放入Option->Dire

2、ctory中，在自己的DSP文件中書寫）。3.1.1 包含語句格式#include<>/ 系統(tǒng)頭文件。#include“”/應用程序的頭文件。系統(tǒng)頭文件的場合，必須使用 <文件名> 的形式。系統(tǒng)頭文件放在應用程序頭文件的前面。應用程序頭文件的場合，必須使用 “文件名” 的形式。#include和文件名之間用TAB鍵分隔。禁止使用絕對路徑。應用程序頭文件的場合、在聲明后面寫上文件的說明。3.1.2 文件的內(nèi)部格式為了避免重復定義，在頭文件中推薦以下形式的書寫方法。#ifndef大寫字母的INCLUDE文件名_H #define大寫字母的INCLUDE文件名_H 文件內(nèi)容

3、#endif3.2 常量的定義3.2.1格式#defineXXXXX<值>/常量的說明const類型 XXXXX = <值>/C+的常量的說明3.2.2說明常量的定義盡量避免 “#define XXXX <値> “的形式。常量名全部用大寫的字母書寫。const和類型之間用TAB分隔在聲明的后面寫上場量的說明3.3宏的定義3.3.1格式#define/宏的說明3.3.2説明作為原則，應盡量不使用C+的宏。替換措施是使用inline函數(shù)。inline函數(shù)要盡量的小。3.4全局變量和函數(shù)3.4.1全局變量作為原則，應盡量避免使用全局變量。在必須使用場合，對全局變量

4、的使用要十分注意。3.4.2全局函數(shù)作為原則，應盡量避免使用全局函數(shù)。在必須使用的場合，對全局函數(shù)的使用要十分注意(對于C+，在一個地方實現(xiàn)，就應該放入一個類中)。3.5外部聲明的變量和函數(shù)3.5.1格式extern外部變量/外部變量的說明extern外部函數(shù)/外部函數(shù)的聲明3.5.2說明外部變量和函數(shù)在使用前必須聲明。3.6條件編譯3.6.1格式條件/ 注釋（or n）條件/ 注釋/ 注釋/ 注釋3.7注釋3.7.1格式C 風格/*/C+ 風格/ 3.7.2說明一般來說，復數(shù)行的文件頭，函數(shù)頭等注釋用C 風格注釋，單行的用C+ 風格注釋。資源文件基本的字符串放在資源文件中字符串標識：IDS_

5、COM_? （共同字符串的場合） IDS_XXX_? （個別字符串的場合，XXX是模塊的標識）3.8類定義的一般形式 例：類：CYYYXXX / / NAME: CYYYXXX / BASE CLASS NAME: 無 / FUNCTION:功能簡述 / class CYYYXXX private: char *szString;public: CYYYXXX() ; CYYYXXX() ;類：CYYYYYY / / NAME: CYYYYYY / BASE CLASS NAME: CYYYXXX / FUNCTION: 功能簡述 / class CYYYYYY :public CYYYXXXprivate: int nNum;public: CYYYYYY() ; CYYYYYY() ;class ： C+中系統(tǒng)指定的KEY,一般情況下必須指定。public、private 、protected: 記述類中的變量和類的可見度。 注：可見度標識（public