JavaScript 命名规范

2019-2-8 16:33| 作者: admin| 查看: 116| 评论: 0|来自: 蚂蚁部落

人与人交往中,有一个常见的沟通媒介就是名片。

也许与此人从未谋面,但是通过名片可以获取此人的一些信息,比如职位或它在工作中的角色。

编程中也是如此,成员良好的命名有利于代码的后期维护和团队开发,看到名称我们大致可以获取如下信息:

(1).成员的角色,比如是普通变量还是常量。

(2).成员的作用,通过名称体现它的功能。

如果没有规则的随意命名,那么我们看到的不仅仅是代码,在一定程度上可以说是密码。

一.三种命名规范简介:

当前有三种非常流行的命名规范,下面对它的命名规则进行简单介绍。

1.驼峰命名:

当名称由多个单词构成时,为了便于识别,遵循如下规则:

(1).第一个单词首字母小写。

(2).第一个单词之后的所有单词首字母大写。

简单演示如下:

[JavaScript] 纯文本查看 复制代码
let loadingModules ={}

从外观看,叫做驼峰命名也算是恰如其分,英文名称是Camel。

2.匈牙利命名法:

此命名法是微软公司推广的命名规范,主要原则如下:

(1).在名称前面添加一个或者多个小写的前缀,此前缀传达一定信息,比如g表是全局成员,c表示常量等。

(2).前缀之后是首字母为大写的一个或者多个单词的组合,用于说明成员的作用。

简单演示如下:

[JavaScript] 纯文本查看 复制代码
g_Servers
CPrintInfo

可以看到前缀可以带有下划线,也可以不带,根据自己或者团队的实际需求。

3.帕斯卡命名法:

与驼峰命名法基本是一样的,只是第一个单词的首字母也要大写。

[JavaScript] 纯文本查看 复制代码
let LoadingModules ={}

二.JavaScript不同类型成员命名规则:

下面进入正题,介绍一下JavaScript不同类型成员命名的一些规范。

在强调一下,下面所介绍的命名规范都是最佳时间,并不是语法规则,没有必要严格遵守,只是建议,具体的命名还需要根据个人或者团队的需要,但是只要规则一旦制定,务必执行到底。

(1).变量命名:

使用驼峰命名发,代码实例如下:

[JavaScript] 纯文本查看 复制代码
let webName="蚂蚁部落";
let address='青岛市南区';

(2).私有成员命名:

如果是私有成员,比如私有变量、方法或者属性,通常以下划线开头。

简单代码实例如下:

[JavaScript] 纯文本查看 复制代码
let _privateMethod = function(){
  // code
}

(3).常量:

常量名称全部用大写形式,如果有多个单词构成,使用下划线分隔。

简单代码实例如下:

[JavaScript] 纯文本查看 复制代码
let HTML_ENTITY = {};

(4).函数命名:

用作普通函数,那么采用驼峰命名法,如果用作构造函数或者类那么采用帕斯卡命名法。

函数的参数使用驼峰命名法,类中的方法与属性也采用驼峰命名法。

简单代码实例如下:

[JavaScript] 纯文本查看 复制代码
function Antzone(webName, address) {
    this.webName = webName;
    this.address = address;
    this.show=function(){
      // code
    }
}

(5).枚举命名:

当前,JavaScript并没有枚举这个概念,在实际编程中可能会根据需要模拟实现。

又或者,在ts等类似语言中实现,枚举变量名称采用帕斯卡命名法,枚举的成员属性全部采用大写形式。

简单代码实例如下:

[JavaScript] 纯文本查看 复制代码
let TargetState = {
    READING: 1,
    READED: 2,
    APPLIED: 3,
    READY: 4
};

(6).多个单词的缩写:

很多时候,一些成员的名称中,有一部分是多个单词的缩写形式。

那么此时,根据你所应用的命名法,和其所出现的位置,大小写形式与第一个字母的大小写一致。

上面的阐述可能令人一头雾水,看下面简单的代码实例:

[JavaScript] 纯文本查看 复制代码
function XMLParser() {}
function insertHTML() {}

XMLParser采用帕斯卡命名法,XML是三个单词的缩写,第一个X是大写,那么后面的ml也需要和X一致。

insertHTML采用驼峰命名法,HTML是四个单词的缩写,第一个H是大写,那么后面的tml也需要保持一致。


鲜花

握手

雷人

路过

鸡蛋

最新评论

返回顶部