C++編程規(guī)范.doc

《C++編程規(guī)范.doc》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、.C++編程規(guī)范1簡介為規(guī)范項(xiàng)目中以C++為基礎(chǔ)語言的代碼風(fēng)格，提到代碼的健壯性、可維護(hù)性，提高開發(fā)效率，特制定本規(guī)范。本規(guī)范具有法律效力，除特別說明，或者項(xiàng)目組得到職權(quán)部門書面核準(zhǔn)，本規(guī)范必須執(zhí)行。1.1目的頒布本規(guī)范的目的是：1.增加代碼的健壯性、可讀性、易維護(hù)性；減少有經(jīng)驗(yàn)和無經(jīng)驗(yàn)開發(fā)人員編程所需的腦力工作；2.在項(xiàng)目范圍內(nèi)統(tǒng)一代碼風(fēng)格；3.通過人為以及自動(dòng)的方式對(duì)最終軟件應(yīng)用質(zhì)量標(biāo)準(zhǔn)；4.使新的開發(fā)人員快速適應(yīng)項(xiàng)目環(huán)境；5.支持項(xiàng)目資源的復(fù)用：允許開發(fā)人員從一個(gè)項(xiàng)目區(qū)域（或子項(xiàng)目團(tuán)隊(duì)）移動(dòng)到另一個(gè)，而不需要重新適應(yīng)新的子項(xiàng)目團(tuán)隊(duì)的氛圍。1.2適用范

2、圍本規(guī)范適用于公司所有以C++語言為基礎(chǔ)的平臺(tái)下開發(fā)的項(xiàng)目。1.3概述本規(guī)范包括內(nèi)容：1.如何組織項(xiàng)目代碼；6.編程風(fēng)格（如何編寫實(shí)際的源代碼）；7.如何記錄源代碼；8.代碼內(nèi)名稱和源文件所使用的命名約定；9.何時(shí)使用某些語言結(jié)構(gòu)以及何時(shí)應(yīng)避免某些語言結(jié)構(gòu)。2基本原則1.清晰、可理解的源代碼是影響軟件可靠性和可維護(hù)性的主要因素。清晰、可理解的代碼可以表示為以下三個(gè)簡單的基礎(chǔ)原理：n最小混淆：軟件的生存期中，源代碼的讀遠(yuǎn)比寫多，規(guī)范、標(biāo)準(zhǔn)更是這樣。理想情況下，源代碼讀起來應(yīng)該象英語一樣描述了所要做的事，這同時(shí)還帶來了它執(zhí)行的好處。程序本質(zhì)上是為人編寫，而不是

3、為計(jì)算機(jī)編寫的。閱讀代碼是一個(gè)復(fù)雜的腦力過程，它可由統(tǒng)一標(biāo)準(zhǔn)來簡化，在本文中還指最小混淆原則。整個(gè)項(xiàng)目中統(tǒng)一樣式是軟件開發(fā)團(tuán)隊(duì)在編程標(biāo)準(zhǔn)上達(dá)成一致的主要原因，它不應(yīng)視為一種懲罰或?qū)?chuàng)造性和生產(chǎn)力的阻礙。n維護(hù)的唯一點(diǎn)：只要可能，設(shè)計(jì)決策就應(yīng)在源中只表述一點(diǎn)，它的多數(shù)后果應(yīng)程序化的派生于此點(diǎn)。不遵守這一原則嚴(yán)重?fù)p害了可維護(hù)性、可靠性和可理解性。n最小干擾：避免將源代碼與可視干擾（如內(nèi)容較少或?qū)斫廛浖康牟黄鹱饔玫男畔ⅲ┫嗷旌希?.精選word范本！.所表達(dá)的精神不過于苛刻；而對(duì)正確安全的使用語言特性提供指導(dǎo)。優(yōu)秀軟件的關(guān)鍵在于：n了解每一個(gè)特性以及它的限制

4、和潛在的危險(xiǎn)；n確切了解此特性可安全的使用于哪一個(gè)環(huán)境中；n做出使用高度可視特性的決定；n在合適的地方小心適度的使用特性。1文件結(jié)構(gòu)每個(gè)C++/C程序通常分為兩個(gè)文件。一個(gè)文件用于保存程序的聲明（declaration），稱為頭文件。另一個(gè)文件用于保存程序的實(shí)現(xiàn)（implementation），稱為定義（definition）文件。C++/C程序的頭文件以“.h”為后綴，C程序的定義文件以“.c”為后綴，C++程序的定義文件通常以“.cpp”為后綴（也有一些系統(tǒng)以“.cc”或“.cxx”為后綴）。1.1版權(quán)和版本的聲明版權(quán)和版本的聲明位于頭文件和定義文件的

5、開頭，主要內(nèi)容有：1.版權(quán)信息。1.文件名稱，標(biāo)識(shí)符，摘要。2.當(dāng)前版本號(hào)，作者/修改者，完成日期。3.版本歷史信息。/***Copyright(c)2004，光庭導(dǎo)航數(shù)據(jù)（武漢）有限公司*Allrightsreserved.**文件名稱：filename.h*摘要：簡要描述本文件的內(nèi)容**當(dāng)前版本：1.1*作者：輸入作者（或修改者）名字*完成日期：2004年×月×日**取代版本：1.0*原作者：輸入原作者（或修改者）名字*完成日期：2004年月日**/【說明】關(guān)于類的版權(quán)和版本申明要保持C＋＋工程和RoseUML模型的統(tǒng)一，鑒于在RoseUML模型中編寫

6、這些聲明比較麻煩導(dǎo)致工作量增加，所以可以在VC中使用“VC助手”工具幫助快速編寫該類的版權(quán)和版本申明，在VC中編寫好申明后要將該C＋＋工程反轉(zhuǎn)到RoseUML模型中，以保持C＋＋工程和RoseUML模型的統(tǒng)一。使用VC助手的方法：1.點(diǎn)擊助手工具欄的Options按鈕2.點(diǎn)擊Completion頁面的Edit按鈕3.找到精選word范本！./**:/************************************************************************//*?*//**************************

7、**********************************************/修改為：/**:/***Copyright(c)2004，光庭導(dǎo)航數(shù)據(jù)（武漢）有限公司*Allrightsreserved.*?*文件名稱：filename.h*摘要：簡要描述本文件的內(nèi)容**當(dāng)前版本：1.1*作者：輸入作者（或修改者）名字*完成日期：2004年月日**取代版本：1.0*原作者：輸入原作者（或修改者）名字*完成日期：2004年月日**/使用方法：在VC中輸入"/**"等待出現(xiàn)提示，然后回車即出現(xiàn)類注釋。n【提示3-1-1】通過上述方法可以在“VC助

8、手”中編輯各種模板以提高編寫代碼的效率。1.1頭文件的結(jié)構(gòu)頭文件由