通用編碼規(guī)范(C++)

《通用編碼規(guī)范(C++)》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。

1、項(xiàng)目編號(hào)版本號(hào)密級(jí)機(jī)密XXXX軟件編碼規(guī)范(C++)V1.0.0作者編寫(xiě)時(shí)間審核審核日期批準(zhǔn)批準(zhǔn)日期KZH版權(quán)所有未經(jīng)KZH的書(shū)面許可，不得以任何形式提供給任何第三方。KZH軟件編碼規(guī)范(C++)版本1.0.0歷史版本記錄日期版本說(shuō)明作者2011-10-14V1.0.0初稿KZH內(nèi)部資料，未經(jīng)許可請(qǐng)勿傳播óKZH,201115/15KZH軟件編碼規(guī)范(C++)版本1.0.0目錄1．引言41.1編寫(xiě)目的41.2參考資料42．編碼規(guī)范42.1程序命名規(guī)范42.1.1目標(biāo)文件命名規(guī)范42.2程序編寫(xiě)格式52.2.1版權(quán)和版本信息聲明52.

2、2.2頭文件結(jié)構(gòu)62.2.3程序版式62.2.4注譯規(guī)范102.3變量命名規(guī)范112.3.1類名規(guī)則112.3.2變量和參數(shù)112.3.3常量112.3.4靜態(tài)變量122.3.5全局變量122.3.6其他變量122.3.6類的數(shù)據(jù)成員122.3.7常見(jiàn)變量命名規(guī)則132.4函數(shù)編寫(xiě)規(guī)則132.4.1函數(shù)命名規(guī)則132.4.2函數(shù)編寫(xiě)規(guī)則132.4.3函數(shù)參數(shù)規(guī)則142.5程序配置142.5版本控制142.6異常處理規(guī)范14內(nèi)部資料，未經(jīng)許可請(qǐng)勿傳播óKZH,201115/15KZH軟件編碼規(guī)范(C++)版本1.0.01．引言1.1編

3、寫(xiě)目的為規(guī)范項(xiàng)目組日常開(kāi)發(fā)編碼，統(tǒng)一項(xiàng)目組內(nèi)部編碼風(fēng)格，提高項(xiàng)目組代碼的可讀性和可維護(hù)性，定制項(xiàng)目組本編碼規(guī)范。1.2參考資料《高質(zhì)量C++編程》2．編碼規(guī)范2.1程序命名規(guī)范2.1.1目標(biāo)文件命名規(guī)范在進(jìn)行項(xiàng)目開(kāi)發(fā)之前項(xiàng)目組需要事先約定好目標(biāo)文件的名稱和文件命名規(guī)則，包含如下內(nèi)容：項(xiàng)目子項(xiàng)說(shuō)明EXE/DLL/LIB執(zhí)行文件KZHXXXX.exeXXXX:用英文縮寫(xiě)表示若英文較長(zhǎng)，則使用英文首字母縮寫(xiě)表示?；蛘呷サ魡卧~中元音字母的方式命名配置文件XML優(yōu)先選擇XML，大的工程使用XML格式的配置文件注冊(cè)表設(shè)備硬件設(shè)置、配置INI盡量

4、避免使用INI文件文件目錄存放規(guī)則執(zhí)行文件存放Bin目錄，存放exe,dll,ocx配置文件存放在Cfg目錄數(shù)據(jù)文件存放Data目錄Trace文件存放在Trace目錄臨時(shí)文件存放在Tmp目錄備份文件存放在Bak目錄內(nèi)部資料，未經(jīng)許可請(qǐng)勿傳播óKZH,201115/15KZH軟件編碼規(guī)范(C++)版本1.0.02.2程序編寫(xiě)格式2.2.1版權(quán)和版本信息聲明每個(gè)程序文件中都要包含版權(quán)和版本信息的聲明，格式如下：/***************************************************************

5、*******版權(quán)聲明：KZH公司?版權(quán)所有*內(nèi)容摘要：*描述文件的內(nèi)容*當(dāng)前版本：*作者：*修改記錄：**********************************************************************標(biāo)簽說(shuō)明1修改人修改時(shí)間，版本號(hào)*修改目的*修改內(nèi)容，*1.修改內(nèi)容1*2.修改內(nèi)容2**n.修改內(nèi)容n**********************************************************************標(biāo)簽說(shuō)明2修改人修改時(shí)間，版本號(hào)*修改目的*修改內(nèi)

6、容，*1.修改內(nèi)容1*2.修改內(nèi)容2**n.修改內(nèi)容n*********************************************************************/關(guān)鍵字說(shuō)明標(biāo)題描述示例標(biāo)簽說(shuō)明程序縮寫(xiě)_4位序號(hào)KzhHfr.dll程序HFR_0001，表示第一次修改KzhHfr.dll程序添加、刪除、修改單行時(shí)在修改行后添加//HFR_0001添加、刪除段落時(shí)可用下面的表示//HFR_0001BEGIN//HFR_0001END程序員可根據(jù)實(shí)際情況自行決定使用哪種方式。修改人張三則為sanzhang,

7、李小四則為xsli內(nèi)部資料，未經(jīng)許可請(qǐng)勿傳播óKZH,201115/15KZH軟件編碼規(guī)范(C++)版本1.0.0使用公司郵箱登錄名，且全部為小寫(xiě)字母修改時(shí)間修改時(shí)間年月日(YYYY-MM-DD)如2009-01-05修改目的簡(jiǎn)要概述本次修改解決的問(wèn)題修改內(nèi)容本次修改所修改的程序點(diǎn)可以有很多點(diǎn)。在程序修改之后編寫(xiě)，主要描述對(duì)程序的改動(dòng)注：（1）在工程中單獨(dú)創(chuàng)建一個(gè)KZHVersionHistory.h文件來(lái)存放工程版權(quán)和版本信息聲明.（2）每個(gè).h（除KZHVersionHistory.h）都有一個(gè)版權(quán)和版本信息聲明（不保存修改內(nèi)容

8、）及類功能簡(jiǎn)要描述。2.2.2頭文件結(jié)構(gòu)頭文件結(jié)構(gòu)包括三部分：（1）版本聲明（2）預(yù)處理（3）函數(shù)和類結(jié)構(gòu)聲明規(guī)則如下：/********************************************************