前端开发规范：JS规范

2017-12-07 本文已影响261人辣瓜瓜

一个项目应该永远遵循同一套编码规范
不管有多少人共同参与同一项目，确保每一行代码都像是同一个人编写的

前端开发规范：JS规范

命名规范

驼峰式命名法介绍

驼峰式命名法由小(大)写字母开始，后续每个单词首字母都大写。
按照第一个字母是否大写，分为：
① Pascal Case 大驼峰式命名法：首字母大写。eg：StudentInfo、UserInfo、ProductInfo
② Camel Case 小驼峰式命名法：首字母小写。eg：studentInfo、userInfo、productInfo

变量

命名方法：小驼峰式命名法
命名规范：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数)
命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型；而包含name、title表示为字符串类型

// 推荐
var maxCount = 10;
var tableTitle = 'LoginTable';
// 不推荐
var setCount = 10;
var getTitle = 'LoginTable';

函数

命名方法：小驼峰式命名法
命名规范：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数)
命名建议：参考下表

函数命名参考

// 是否可阅读
function canRead() {
    return true;
}
 
// 获取名称
function getName() {
    return this.name;
}

常量

命名方法：名称全部大写
命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词

var MAX_COUNT = 10;
var URL = 'http://www.xxx.com';

构造函数

命名方法：大驼峰式命名法，首字母大写

function Student(name) {
    this.name = name;
}
var st = new Student('tom');

类的成员

公共属性和方法：跟变量和函数的命名一样
私有属性和方法：前缀为_(下划线)，后面跟公共属性和方法一样的命名方式

function Student(name) {
    var _name = name; // 私有成员 
    // 公共方法
    this.getName = function () {
        return _name;
    }
    // 公共方式
    this.setName = function (value) {
        _name = value;
    }
}
var st = new Student('tom');
st.setName('jerry');
console.log(st.getName()); // => jerry：输出_name私有变量的值

注释规范

单行注释

说明：单行注释以两个斜线开始，以行尾结束
语法：// 这是单行注释
使用方式：

单独一行：//(双斜线)与注释文字之间保留一个空格。
在代码后面添加注释：//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格
注释代码：//(双斜线)与代码之间保留一个空格

// 调用了一个函数；1)单独在一行
setTitle();
var maxCount = 10; // 设置最大量；2)在代码后面注释
// setName(); // 3)注释代码

多行注释

说明：以/开头，/结尾
语法：/* 注释说明 */
使用方式：

若开始(/)和结束(/)都在一行，推荐采用单行注释
若至少三行注释时，第一行为/，最后行为/，其他行以开始，并且注释文字与保留一个空格

/*
* 代码执行到这里后会调用setTitle()函数
* setTitle()：设置title的值
*/
setTitle();

函数(方法)注释

说明：函数(方法)注释也是多行注释的一种，但是包含了特殊的注释要求，参照 javadoc(百度百科)
更多注释内容，可参考JSDOC ：http://usejsdoc.org
语法：

/** 
* 函数说明 
* @关键字 
*/

注释名	语法	含义	示例
@param	@param 参数名 {参数类型} 描述信息	描述参数的信息	@param name {String} 传入名称
@return	@return {返回类型} 描述信息	描述返回值的信息	@return {Boolean} true:可执行;false:不可执行
@autho	@author 作者信息 [附属信息：如邮箱、日期]	描述此函数作者的信息	@author 张三 2015/07/21
@version	@version XX.XX.XX	描述此函数的版本号	@version 1.0.3
@example	@param 参数名 {参数类型} 描述信息	描述参数的信息	@param name {String} 传入名称
@param	@example 示例代码	演示函数的使用	@example setTitle('测试')

/**
* 合并Grid的行
* @param {Grid} grid 需要合并的Grid
* @param {Array} cols 需要合并列的Index(序号)数组；从0开始计数，序号也包含。
* @param {Boolean} isAllSome 是否2个tr的cols必须完成一样才能进行合并。true：完成一样；false(默认)：不完全一样
* @return void
* @author polk6 2015/07/21 
* @example
* _________________                             _________________
* |  年龄 |  姓名 |                             |  年龄 |  姓名 |
* -----------------      mergeCells(grid,[0])   -----------------
* |  18   |  张三 |              =>             |       |  张三 |
* -----------------                             -  18   ---------
* |  18   |  王五 |                             |       |  王五 |
* -----------------                             -----------------
*/
function mergeCells(grid, cols, isAllSome) {
    // Do Something
}

避免全局变量污染命名空间

全局变量定义：

在任何函数外面定义var语句：var a = 'value';
直接添加属性在全局对象上：window.a = 'value';
直接使用未经声明的变量：a = 'value';

避免方式：

采用闭包的立即执行的方式，不要污染全局变量；

（funcction(){        
        //  to do ...    
}）(window)

定义一个全局变量的命名空间
为了避免全局变量的污染，尽可能创建一个全局变量，让其他对象和函数存在其中

var variate={
          maxCount :'xxx',
          minCount :'xxx',
          canRead :function(){
    }
}

注意：即使包在函数中的未经声明的变量，在函数执行过后也会变成全局变量

function XX(){
      name = "abc"
};
console.log("----"+window.name)   //----


function XX(){
      name = "abc"
};
XX();
console.log(window.name)   //abc


function XX(){
        var name = "123ed"
};
XX();
console.log("----"+window.name)     //----

在匿名自执行函数中使用严格模式

(function(){
      'use strict';

      $(function() {
             //  to do ... 
        });
}());

避免声明全局变量，尽可能在函数体顶部声明局部变量

== 和严格等===的区别

== equality 等同：两边值类型不同的时候，要先进行类型转换，再比较
=== identity 恒等：不做类型转换，类型不同的一定不等

下面的规则用来判断两个值是否===相等：

如果类型不同，就[不相等]
如果两个都是数值，并且是同一个值，那么[相等]；
例外的是，如果其中至少一个是NaN，那么[不相等]
（判断一个值是否是NaN，只能用isNaN()来判断）
如果两个都是字符串，每个位置的字符都一样，那么[相等]；否则[不相等]
如果两个值都是true，或者都是false，那么[相等]
如果两个值都引用同一个对象或函数，那么[相等]；否则[不相等]
如果两个值都是null，或者都是undefined，那么[相等]；否则[不相等]

下面的规则用来判断两个值是否==相等：

如果两个值类型相同，进行 === 比较。
如果两个值类型不同，他们可能相等。详细划分为：
a. 如果一个是null、一个是undefined，那么[相等]。
b. 如果一个是字符串，一个是数值，把字符串转换成数值再进行比较
c. 如果任一值是 true，把它转换成 1 再比较；如果任一值是 false，把它转换成 0 再比较
d. 如果一个是对象，另一个是数值或字符串，把对象转换成基础类型的值再比较。
对象转换成基础类型，利用它的toString或者valueOf方法
js核心内置类，会尝试valueOf先于toString；
例外的是Date，Date利用的是toString转换
非js核心的对象不适用
e. 任何其他组合，都[不相等]。

IF真假判断

在一个 if 条件语句中使用变量或表达式时，会做真假判断。if(a == true) 不同于 if(a) 。后者的判断比较特殊，我们称其为真假判断。
这种判断会通过特殊的操作将其转换为 true 或 false，下列表达式统统返回 false：false、 0、 undefined、null、NaN、 ' '（空字符串）

变量赋值时的逻辑操作

逻辑操作符 || 和 && 也可被用来返回布尔值。
如果操作对象为非布尔对象，每个表达式将会被自左向右地做真假判断
基于此操作，最终总有一个表达式被返回回来，这在变量赋值时，可以用来简化代码

//不推荐
  if(!x) {
        if(!y) {
              x = 1;
        } else {
              x = y;
        }
  }
//推荐
    x = x || y || 1;

这一小技巧经常用来给方法设定默认的参数

    a = a || 1;
    b = b || 1;

语句块内的函数声明

切勿在语句块内声明函数，在 ECMAScript 5 的严格模式下，这是不合法的。函数声明应该在定义域的顶层。但在语句块内可将函数申明转化为函数表达式赋值给变量。

//不推荐
    if (x) {
          function foo() {}
    }
//推荐
    if (x) {
          var foo = function() {};
    }

this 关键字

它时而指向全局对象（大多数时），时而指向调用者的定义域（在 eval 中），时而指向 DOM 树中的某一节点（当用事件处理绑定到 HTML 属性上时），时而指向一个新创建的对象（在构造器中），还时而指向其它的一些对象（如果函数被 call() 和 apply() 执行和调用时），使用this时注意其使用场景

数组和对象字面量

用数组和对象字面量来代替数组和对象构造器。数组构造器很容易让人在它的参数上犯错

//不推荐
//数组
// Length is 3.
var a1 = new Array(x1, x2, x3);
// Length is 2.
var a2 = new Array(x1, x2);
// If x1 is a number and it is a natural number the length will be x1.
// If x1 is a number but not a natural number this will throw an exception.
// Otherwise the array will have one element with x1 as its value.
var a3 = new Array(x1);
 
// Length is 0.
var a4 = new Array();

//对象
var o = new Object();
 
var o2 = new Object();
o2.a = 0;
o2.b = 1;
o2.c = 2;
o2['strange key'] = 3;

//推荐
//数组
var a = [x1, x2, x3];
var a2 = [x1, x2];
var a3 = [x1];
var a4 = [];

//对象
var o = {};
var o2 = {
      a: 0,
      b: 1,
      c: 2,
      'strange key': 3
};

不要使用 eval()语句

不要使用 eval()语句,因为它存在安全隐患，导致脚本注入攻击，并且在不同的浏览器引擎下还有效率上的差异

不要在循环里面进行DOM操作

//推荐
var htmlString = "";

for(var i =0; i<length;i++){
    htmlString += html;
}

$(“.class”).append(htmlString);

//不推荐
for(var i =0; i<length;i++){
    $(“.class”).append(html);
}

减少js操作DOM

在js操作DOM的过程中，要避免频繁改动DOM结构，可以先使用字符串方式组装html代码，再插到DOM结构中去

使用事件委托

对于多个同性质同辈节点，避免逐个进行事件绑定。而应该利用冒泡原理，将事件委托给父节点。
事件委托要接近事件触发节点，避免将所有事件冒泡委托给body节点

//推荐
$("table").on("click","td",function(){

})

//不推荐
$("td").on("click",function(){

})

能用CSS实现不用JS实现

JS尽可能避免直接写在页面中，加快加载速度

使用jQuery缓存

在使用jQuery时，需要用缓存的方式，避免重复产生过多的jQuery对象

//推荐
var cached = $('#top'); 
cached.find('p.classA'); 
cached.find('p.classB'); 

//不推荐
$('#top').find('p.classA'); 
$('#top').find('p.classB');

使用jQuery链式写法

$('class').find('h3').eq(2).html('Hello');

参考引用：
http://www.css88.com/archives/5366
https://www.cnblogs.com/polk6/p/4660195.html
http://blog.csdn.net/kydkong/article/details/52087043#

前端开发规范：JS规范

相关链接：

命名规范

驼峰式命名法介绍

变量

函数

常量

构造函数

类的成员

注释规范

单行注释

多行注释

函数(方法)注释

避免全局变量污染命名空间

== 和严格等===的区别

下面的规则用来判断两个值是否===相等：

下面的规则用来判断两个值是否==相等：

IF真假判断

变量赋值时的逻辑操作

语句块内的函数声明

this 关键字

数组和对象字面量

不要使用 eval()语句

不要在循环里面进行DOM操作

减少js操作DOM

使用事件委托

能用CSS实现不用JS实现

JS尽可能避免直接写在页面中，加快加载速度

使用jQuery缓存

使用jQuery链式写法

猜你喜欢

热点阅读