c++代碼書(shū)寫(xiě)規(guī)范

《c++代碼書(shū)寫(xiě)規(guī)范》由會(huì)員上傳分享，免費(fèi)在線(xiàn)閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。

1、標(biāo)題C++代碼書(shū)寫(xiě)規(guī)范DraftV0.32013.10.17文檔管理日期版本作者注解2012.9.140.1創(chuàng)建文檔9標(biāo)題2013.3.110.2增加示例代碼2013.10.170.3增加規(guī)范9標(biāo)題目錄1目的42命名規(guī)范43代碼書(shū)寫(xiě)規(guī)范54反例89標(biāo)題1目的為確保工程的進(jìn)度，我們需要制定統(tǒng)一的代碼書(shū)寫(xiě)和命名規(guī)范，以使整個(gè)工程的風(fēng)格一致，讓不同的團(tuán)隊(duì)成員可以方便地閱讀別人寫(xiě)的代碼，避免因代碼書(shū)寫(xiě)不規(guī)范帶來(lái)的麻煩。2命名規(guī)范（1）所有的文件名、類(lèi)名、對(duì)象名稱(chēng)、函數(shù)名和變量名都要求具有明確的意義，盡量避免使用無(wú)意義的字母和數(shù)字的組合來(lái)命名。每個(gè)單詞都用大寫(xiě)字母開(kāi)頭，盡量不要使用下劃線(xiàn)。如：文件名：

2、IUpixImageFilter.h類(lèi)名：classIUpixImageFilter;變量名：IUpixImageFilter*pImageFiler;函數(shù)名：staticIUpixImageFilter*CreateImageFilter(eUpixColorFormateType);（2）普通類(lèi)名都冠以Upix前綴，如：templateclassUPIX_ALGORITHM_TEMPLATEUpixArray;（3）抽象接口類(lèi)的名字一律以大寫(xiě)的I開(kāi)頭，再冠以Upix前綴。接口類(lèi)頭文件的名字也以大寫(xiě)的I開(kāi)頭，如：IUpixImageFilter.hclassIUpix

3、ImageFilter;（4）變量名采用匈牙利命名法，變量名之前必須加一個(gè)小寫(xiě)字母以標(biāo)明它的數(shù)據(jù)類(lèi)型。數(shù)據(jù)類(lèi)型前綴指針p，數(shù)組可以不加intI或者nfloatfdoubled字符串str對(duì)象ovectorvmapmap如：9標(biāo)題IUpixImageFilter*pImageFiler;intnSize;floatfScale;charstrFileName[256];vectorvIndices;（5）若非公開(kāi)的成員變量，最好都加上前綴m_，指針用m_p，整數(shù)用m_n等，如：IUpixMeshCreater*m_pMeshCreater;intm_nSize;（6）每一個(gè)需要導(dǎo)出到

4、dll的類(lèi)，都要在聲明中加上一個(gè)class導(dǎo)出宏，例如在UpixAlgorithm中定義的導(dǎo)出宏為：#ifndefUPIX_ALGORITHM_EXPORTS#defineUPIX_ALGORITHM_API__declspec(dllimport)#defineUPIX_ALGORITHM_CLASS__declspec(dllimport)#defineUPIX_ALGORITHM_TEMPLATE#else//EXPORT#defineUPIX_ALGORITHM_API__declspec(dllexport)#defineUPIX_ALGORITHM_CLASS__declspec

5、(dllexport)#defineUPIX_ALGORITHM_TEMPLATE__declspec(dllexport)#endif那么在類(lèi)中應(yīng)該加上UPIX_ALGORITHM_CLASS，如：classUPIX_ALGORITHM_CLASSUpixException;（7）每一個(gè)需要導(dǎo)出到dll的模版類(lèi)，都要在聲明中加上一個(gè)template導(dǎo)出宏，如：templateclassUPIX_ALGORITHM_TEMPLATEUpixMatrix（8）每一個(gè)需要導(dǎo)出到dll的函數(shù)，都要在聲明中加上一個(gè)API導(dǎo)出宏，如：voidUPIX_ALGORITHM_APIUpix

6、GetFileExtension(constchar*strPathName,char*strExt);1代碼書(shū)寫(xiě)規(guī)范（1）所有函數(shù)在聲明時(shí)必須加注釋。實(shí)現(xiàn)函數(shù)時(shí)，邏輯復(fù)雜的地方必須注釋清楚，其它地方視情況而定，以能讀懂該段代碼為準(zhǔn)。如：//BlurpImageSrcusingfastboxmethod9標(biāo)題boolBoxBlur(constvoid*pImageSrc,void*pImageDst,intwidth,intheight,intradius);（2）頭文件都用#ifndef和#endif包括起來(lái)，不要使用#pragmaonce，如：#ifndef_I_UPIX_MESH_CR

7、EATER_H_#define_I_UPIX_MESH_CREATER_H_……#endif（3）頭文件中盡可能少包含別的頭文件，能在*.cpp中包含的就不要在*.h中包含。如果實(shí)在需要在頭文件中引用某個(gè)類(lèi)，可以在頭文件中單獨(dú)聲明該類(lèi)，并用指針引用該類(lèi)，這樣就可以把該類(lèi)的頭文件放到*.cpp中去包含。如：在UpixObserver.h中：templateclassUPIX_ALGORITHM_