在我们进行编写程序的时候为了提高程序的可读性、增强后期可维护性、促进团队协作、提升我们的代码质量、方便代码管理、建立代码风格共识,就需要我们有一个良好的命名规则和代码风格。
今天讲一下关于变量、函数、类名的命名规则。
规则一:名称应由字母、数字、下划线和汉字组成,并且以字母或下划线开头
字母:26个英文字母,大小写均可。
汉字:中文汉字。(汉字在WPS宏脚本中是可以用来命名的)
数字:0-9阿拉伯数字。
下划线:半角状态的下划线“_”。
千万不可以数字作为名称的首字符,否则会报错。
注意:WPS宏脚本是区分大小写的,因此变量A和变量a是不同的变量,不要搞混淆了。
下图演示的是中文命名
规则二:名称应避开系统的保留关键字。
在WPS宏脚本中,下表是一些常见的系统保留关键字:
序号 | 关键字 | 功能 | 序号 | 关键字 | 功能 |
1 | await | 用于异步操作 | 24 | instanceof | 用于检查对象是否是某个类的实例 |
2 | break | 用于跳出循环或switch语句 | 25 | interface | 用于定义接口 |
3 | case | 用于switch语句中的分支 | 26 | let | 用于定义块级作用域的变量 |
4 | catch | 用于捕获异常 | 27 | new | 用于创建对象 |
5 | class | 用于定义类 | 28 | null | 表示空值 |
6 | const | 用于定义常量 | 29 | package | 用于 Java 中的包 |
7 | continue | 用于继续下一次循环迭代 | 30 | private | 用于定义私有成员 |
8 | debugger | 用于调试 | 31 | protected | 用于定义受保护的成员 |
9 | default | 用于switch语句中的默认分支 | 32 | public | 用于定义公共成员 |
10 | delete | 用于删除对象的属性或数组的元素 | 33 | return | 用于从函数中返回值 |
11 | do | 用于do-while循环 | 34 | static | 用于定义静态成员 |
12 | else | 用于if-else语句中的否则分支 | 35 | super | 用于访问父类的成员 |
13 | enum | 用于定义枚举类型 | 36 | switch | 用于switch语句 |
14 | export | 用于导出模块的功能 | 37 | this | 指代当前对象 |
15 | extends | 用于类的继承 | 38 | throw | 用于抛出异常 |
16 | false | 布尔值,表示假 | 39 | true | 布尔值,表示真 |
17 | finally | 用于try-catch语句中的最终块 | 40 | try | 用于try-catch语句中的尝试块 |
18 | for | 用于for循环 | 41 | typeof | 用于获取数据类型 |
19 | function | 用于定义函数 | 42 | var | 用于定义函数作用域或全局作用域的变量 |
20 | if | 用于条件判断 | 43 | void | 用于表示无返回值 |
21 | implements | 用于实现接口 | 44 | while | 用于while循环 |
22 | import | 用于导入模块 | 45 | with | 用于扩展对象的作用域 |
23 | in | 用于遍历对象的属性或数组的元素 | 46 | yield | 用于生成器函数 |
以上这些被系统保留的关键字,我们在实际编程过程中,不应使用它们作为我们自定义的变量名、函数名或其他标识符,否则会引起语法错误。
规则三:确保名称所表达的意义准确
我们的名称应该容易识别,具有传达名称所代表的作用的基本功能。这样的好处是:大家都容易识别,并能理解程序作者的思路。
比如:我们编写一个两数相除的函数
function gggg(a,b)
{
if(b!==0)
{
return a/b;
}
else
{
return "除数不能为0!";
}
}
上面这个函数从函数运行的角度来说,是没有问题的,
但是不从函数运行角度去看,问题就严重了:
1、函数名称gggg,光看名字谁都不知道这个函数是做什么用的。
2、参数a,b又代表了什么?
可以说,这个函数除了作者之外,其他人在调用的时候会一脸蒙,不知所措。
我们可以做如下改进:
function IntDivide(dividend,divisor)
{
if(divisor!==0)
{
return dividend/divisor;
}
else
{
return "除数不能为0!";
}
}
这样,大家在调用的时候就知道,哦,dividend是被除数,divisor是除数。。
甚至我们还可以这样写
function ZSChufa(bChuShu,ChuShu)
{
if(ChuShu!==0)
{
return bChuShu/ChuShu;
}
else
{
return "除数不能为0!";
}
}
用拼音来传达关于这个函数的部分意思。而在我们WPS宏脚本环境下,是可以用中文来作为名称的。
function 整数除法(被除数,除数)
{
if(除数!==0)
{
return 被除数/除数;
}
else
{
return "除数不能为0!";
}
}
上面的这种做法是不是让大家很高兴?中文总比英文亲切啊。
规则四:常量的命名中如果有字母则采用全大写字母加下划线组合的命名方式,或用特殊标记的中文命名
如下面的常量命名:
const PI_2DIGIST = 3.14;
const 常_圆周率派_2位小数 = 3.14;
//以上两种都是合法的。都可以。
规则五:采用固定的主流命名法,风格保持一致。
我这里推荐采用驼峰命名法:
1、小驼峰:一个单词小写,后面的每个单的首字母大写(如:myVariable、myFunctionName)
2、大驼峰:所有单词首字线都大写(如:MyVariable,MyClassName)
我们还可以自己形成自己的命名风格,前提是你的代码只是你自己看,不给别人看。
当你与别人合作写代码时,就要保持命名风格一致,而不能各搞各的。
本文暂时没有评论,来添加一个吧(●'◡'●)