您的位置:首页 > 移动开发 > Cocos引擎

cocos lua 客户端项目规范

2016-05-17 15:14 316 查看
项目今天基本上结尾了,这是项目组第一个项目,有新人(我也是),所以还是出了很多不统一的地方,删删改改两天,基本上好了,但代码不是很规范,为了更高效的书写代码,总结一些经验,打成统一下个项目估计就好多了。在此做个分享。为什么写这些,因为你的代码除了给自己看还是给别人看的。好习惯一但养成,下次就轻车熟路,不必纠结。

-、命名规则

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

                                                                                                                                                                             
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  lua cocos 命名 经验 总结