Creator开发规范
1.编辑器统一使用VSCode, git GUI 统一使用 SourceTree
2.代码写完后需要格式化文档(ctrl+shift+f) 整理import语句(ctrl+shift+o)
3.打印日志统一使用cc.log 禁止console.log 如果要自定义 请在cc_preview中不要使用 不然调试时无法知道日志是在哪一行
4.除了需要在cocos creator中绑定东西 否则不要将变量添加@property
5.除了自定义组件外 不要使用类似executeInEditMode这样
自定义组件请继承 cc.Component
6.代码统一的命名规范, 推荐使用小驼峰 除了消息名称
7.预制prefab统一的命名规范, 最好使用_进行分词
8.统一的编码规范, 大括号不换行 else和上一个大括号同行 不要没大括号
9.使用 “ 而不要用 ‘
10.import结尾不要有 ;
11.发送消息时使用send
12.除了需要继承的基类 只new一次的class 最好使用namespace
13.方法合集 请使用namespace 方便引用时 git进行合并
14.如果使用单例 请使用命名空间 或者 export default new 对象(可以是xxx.Instance)
15.不要使用 new cc.Color | new cc.Rect, 请使用 cc.color | cc.rect
16.尽量使用 cc.tween 而不是 cc.Action, 在高版本creator中会警告的
17.尽量不要写会产生警告和错误的代码 除非是外部js扩展引起的
18.枚举在外面请使用enum 如果需要在@property使用 此时再用cc.Enum()包起来
19.返回值不为空的方法 请定义返回值
20.对常用对象 请通过接口interface来定义对象类型 成员变量一定要定义类型
21.尽量不要保留不需要的代码 除非非常可能会使用的和测试代码
22.不要有basefunc 各个module定义自己的func 除非非常纯粹的方法 并且一定要有方法描述 推荐插件(doc this)
22.array或object 每一组key最后一定要有 , 方便扩展
{
a,
b,
}
23.每个ts最后一定要空一行 方便扩展
24.如果不是代码中调用的资源 请不要放在reurces下 统一放在res下
res/
modulexxx/
res/
modulexxx/
scripts/
modulexxx/
25.如果sp.Skeleton组件设置了播放完成回调setCompleteListener, 需要在onDestroy之前设置为空setCompleteListener(null)
26.回调函数使用匿名函数, 而不是使用临时变量self来保存this