编码规范

倖福魔咒の 提交于 2019-11-28 15:16:20

1,资源管理器中,除脚本组件名首字母大写外,其余资源名称统一小写.

2,层级管理器中的节点命名,资源管理器中的资源名称,项目名称,项目所在路径名称.
都不可以出现中文.

3,代码中的变量名,函数名,统一使用小驼峰命名规则,除特殊需要,否则不要使用下划线.
比如定义一个按钮节点的引用:
buttonStart:cc.Node
比如定义一个类的成员函数:
onButtonClicked(){

}

4,函数命名尽量以动词或介词作为前缀,回调函数通常以on做前缀或handle做后缀,
尽可能做到见名知意.
比如触摸开始事件的回调函数可命名为onTouchStart
比如按钮的点击回调函数可命名为:onButtonClicked

5,函数注释统一采用多行注释,比如定义一个定义一个查找质数的函数,
变量初始化或函数内部代码段注释使用单行注释

/*

  • statement 判断质数 //函数功能说明
  • @parm (Number) num //参数说明
  • @return (Boolean) //返回类型说明
    */
    checkPrimeNumber(num){
    //默认不是质数
    let isPrimeNubmer = false;
    .
    .
    .
    return isPrimeNubmer;
    }

6,运算符前后统一留一个空格.

7,统一使用tab键进行缩进,或者利用编辑器的自动格式化代码功能,
比如vsCode可以使用快键键 shift + alt + f

8,尊重不同语言的语法习惯,做到入乡随俗,比如在JS代码中,
大括号的前半个括号是不建议另起一行的,特别是返回值为一个键值对时.
规范的写法:
let obj = {
name: “Lucy”,
age: “16”
}

不规范的写法:
let obj =
{
name: “Lucy”,
age: “16”
}
原因:
function getPosition(){
//规范写法下,可以正常返回
return {
x:100,
y:200
}
}
function getPosition(){
//不规范写法下,返回值为undefined
return
{
x:100,
y:200
}
}

9,常量名使用全大写,比如GAMESTATE = 1;

10,杜绝硬编码问题.

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!