資源描述:
《程序編碼規(guī)范》由會員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫。
1、讓虛擬世界和現(xiàn)實世界成為相互的起點(diǎn)和終點(diǎn)蝸牛游戲程序編碼規(guī)范(版本0.1)規(guī)范說明:1一、命名規(guī)則1二、程序的版式3三、注釋5四、服務(wù)端平臺無關(guān)7五、服務(wù)端表格操作7六、客戶端文件讀寫8七、客戶端內(nèi)存操作8八、腳本內(nèi)的注釋9規(guī)范說明:制定該規(guī)范的目的是讓程序清晰易懂、易維護(hù)、易管理。該規(guī)范為強(qiáng)制規(guī)范,必須執(zhí)行,如果有沒涉及的地方請參考《高質(zhì)量C++-C編程指南》。當(dāng)所在編程環(huán)境(如MFC、Linux)與本規(guī)范有差異時,可以使用所在編程環(huán)境的規(guī)范,但是同一個項目必須是統(tǒng)一的規(guī)范。最后希望大家都能養(yǎng)成一個良好的程序習(xí)慣,一個好的習(xí)慣受益終身!-9-工具
2、開發(fā)支持管理讓虛擬世界和現(xiàn)實世界成為相互的起點(diǎn)和終點(diǎn)一、命名規(guī)則1.所有命名應(yīng)當(dāng)直觀且可拼讀,并具有實際意義;2.類名和函數(shù)名用大寫字母開頭的單詞組合而成,接口類名以I開頭;3.常量全用大寫的字母,用下劃線分割單詞,盡量不要使用宏;4.類的數(shù)據(jù)成員加前綴m_,全局變量加前綴g_,靜態(tài)變量加前綴s_;5.變量名第一個字母小寫,使用“名詞”或“形容詞+名詞”的詞義表示法;示例:·局部變量char*pStringBuffer;int&stringFindResult;boolisEngineStartup;·函數(shù)命名unsignedintGetVoyag
3、eCoreState();staticboolGetVoyageServiceCount(int&count);·結(jié)構(gòu)類型structNodeValue{intwidth;intheight;}·枚舉類型(枚舉值必須大寫且有前綴)enumVoyageSupportType{VOYAGE_OS_SUPPORT_INVALID=1,VOYAGE_OS_SUPPORT_WINDOWS=2}·聯(lián)合類型unionColor{unsignedchararrColor[3];structColorRGB{unsignedcharr;unsignedcharg;u
4、nsignedcharb;};};·類類型-9-工具開發(fā)支持管理讓虛擬世界和現(xiàn)實世界成為相互的起點(diǎn)和終點(diǎn)classObject{intm_width;//寬度intm_height;//高度voidSetValue(intwidth,intheight);//成員函數(shù)virtualintGetArea();//虛函數(shù)inlineintGetWidth();//內(nèi)聯(lián)函數(shù)};·抽象類classISpriteManager{public:virtualintGetSpriteID()=0;virtualboolIsSpriteExist()=0;};·自
5、定義類型typedefunsignedintNumber;·全局變量(我們不主張使用全局變量)intg_howManyPeople;·靜態(tài)變量staticchar*s_pStringBuffer;·常量constfloatSPRINT_RADIUS=100.0f;·回調(diào)函數(shù)typedefint(*CALLBACK_SYSTEMINIT_FUNC)(IKernel*pKernel);一、程序的版式1.一行代碼只做一件事情,只寫一條語句,語句排版整齊;2.關(guān)鍵字之后要留空格,賦值操作符、比較操作符、算術(shù)操作符、邏輯操作符、位域操作符,如“=”、“+=”
6、“>=”、“<=”、“+”、“*”、“%”、“&&”、“
7、
8、”、“<<”,“^”等二元操作符的前后應(yīng)當(dāng)加空格,一元操作符如“!”、“~”、“++”、“--”、“&”(地址運(yùn)算符)等前后不加空格,象“[]”、“.”、“->”這類操作符前后不加空格;3.程序的分界符‘{’和‘}’應(yīng)獨(dú)占一行并且位于同一列,同時與引用它們的語句左對齊。{}之內(nèi)的代碼塊在‘{’右邊4格處左對齊,這里的4格也可以是VisualStudio里的一個TAB;4.代碼行最大長度宜控制在80個字符以內(nèi);-9-工具開發(fā)支持管理讓虛擬世界和現(xiàn)實世界成為相互的起點(diǎn)和終點(diǎn)1.代碼應(yīng)按功能分塊
9、,代碼塊之間必須有空行,而且每個代碼塊不要超過10行。示例:·語句分行和空格(▲表示空格)for▲(inti▲=▲0,▲j▲=▲0;(i▲<▲backBufferWidth)▲&&▲(j▲<▲backBufferHeight);i++,▲j++){...//programcode}if▲(n▲>▲5){…}elseif▲(n▲<▲0){…}else{…}while▲(a▲>▲b){…}do{…}while▲(a▲>▲b);switch▲(n){case▲1:▲▲▲▲{▲▲▲▲w▲=▲w▲+▲2;}break;}·代碼塊-9-工具開發(fā)支持管理讓虛擬世
10、界和現(xiàn)實世界成為相互的起點(diǎn)和終點(diǎn)………//獲得字符串長度。intlength=(int)strlen(pString);/