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

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

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

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

4、的使用要十分注意。3.4.2全局函數(shù)作為原則，應(yīng)盡量避免使用全局函數(shù)。在必須使用的場(chǎng)合，對(duì)全局函數(shù)的使用要十分注意(對(duì)于C+，在一個(gè)地方實(shí)現(xiàn)，就應(yīng)該放入一個(gè)類(lèi)中)。3.5外部聲明的變量和函數(shù)3.5.1格式extern外部變量/外部變量的說(shuō)明extern外部函數(shù)/外部函數(shù)的聲明3.5.2說(shuō)明外部變量和函數(shù)在使用前必須聲明。3.6條件編譯3.6.1格式條件/ 注釋?zhuān)╫r n）條件/ 注釋/ 注釋/ 注釋3.7注釋3.7.1格式C 風(fēng)格/*/C+ 風(fēng)格/ 3.7.2說(shuō)明一般來(lái)說(shuō)，復(fù)數(shù)行的文件頭，函數(shù)頭等注釋用C 風(fēng)格注釋?zhuān)瑔涡械挠肅+ 風(fēng)格注釋。資源文件基本的字符串放在資源文件中字符串標(biāo)識(shí)：IDS_

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