天天看點

cocos lua 用戶端項目規範

項目今天基本上結尾了,這是項目組第一個項目,有新人(我也是),是以還是出了很多不統一的地方,删删改改兩天,基本上好了,但代碼不是很規範,為了更高效的書寫代碼,總結一些經驗,打成統一下個項目估計就好多了。在此做個分享。為什麼寫這些,因為你的代碼除了給自己看還是給别人看的。好習慣一但養成,下次就輕車熟路,不必糾結。

-、命名規則

1.類(class RewardLayer)帕斯卡命名法。

2.類中的方法名(RewardLayer:showTime()),首字母小寫,駱駝命名法。

3.類中成員變量(self._isOver),加下劃線,後面駱駝命名法。

4.類中的臨時變量(local isOver),不用加下滑線,駝峰法,類中使用資源應該明了(buttonGetReward,texShowTime,picBankGround,panelRoot)

5.全局變量(g_isOver),前面g_,後面駱駝命名法。

6.全局方法名,G_getReward(),前面G_,後面駝峰命名法。

7.宏(OPEN_VIEW = “openView”),全大寫下劃線。

8.UI工程導出的資源檔案使用帕斯卡命名法【OnlineReward】且.csb  .plist  .png  命名一緻。

9.cocosUI命名:所有的圖檔,聲音,動畫資源必須小寫命名,否則打包會出錯   button_fish,tex_show_time,login.mp3,(匈牙利命名法)。這錯誤很麻煩,崩潰的心都有。

10.lua中的配置檔案(config目錄下)都以小寫加下劃線【protps_config】(匈牙利命名法)。

11.無特殊情況,不允許用中文命名。

二、代碼規範及其他規範

1.注釋,所有變量,方法在申明時必須注釋其用途,私有變量、必須在構造時賦初值并注釋。

2.比較難以了解的地方必須注釋。

3.所有代碼必須用tab檔案按結構對齊。

4.Lua工程中加載csb隻在UIBase裡加載其他地方不準許加載。

5.UI工程中的資源路徑不要與項目工程路徑一緻 全放在根目錄下參考聊天UI工程。

6.所有圖檔資源,先打成pist包,plist打包必須盡可能的壓縮。

7.無特殊情況都采用mvc子產品完成業務功能。

8.svn上傳更新必須先update,所有涉及他人或公用的代碼修改必須和負責相應子產品的人溝通後再上傳,比如說大廳檔案(HallLayer)修改,必須先update,

  再跟負責人楊松溝通後,再上傳。為了代碼的安全性,每天盡可能的在下班前備份一次代碼。

9,cocos studio盡可能使用公共資源,所有公共資源不得重複導入。

10.無用的代碼在最終送出時,必須全部删除。

11.所有對象的名字跟類名必須一樣,隻有大小寫的區分,對象小寫開頭,類大寫開頭。

第一次寫技術部落格,也許有不成熟,更多強調的是團隊之間的總結和規範,還是個人習慣的養成,勉強成自然。

                                         沐目之雲   深圳  16.05.17