JavaScript 编程规范

摘自：http://www.cnblogs.com/polk6/p/4660195.html
编程规范化的是为了易于阅读和交流。这个也是一个程序员应该注意的地方。
本篇主要介绍JS开发规范：

1. 命名规则

驼峰式命名法：驼峰式命名法是由小（大）写字母开始，后续每个单词首字母都大写。
首字母大写为大驼峰，eg: StudentInfo、UserInfro。
首字母小写为小驼峰，eg:studentInfo、userInfo

1.1 命名方法：小驼峰

命名规范：前缀应当是名词
命名建议：尽量在变量名字中体现所属类型，如：length、count等表示数字类型；而包含name、title表示为字符串类型。
比如：

//好的命名方式var maxCount=10; var tableTitle='LoginTable';//不好的命名方式var setCount=10;var getTitle='LoginTable';

1.2 函数

命名方法：小驼峰式命名法
命名规范： 前缀应当为动词
命名建议：可使用常见动词约定
常见词：

 can: 判断是否可执行某个动作，返回值为布尔值 has：判断是否含有某个值，返回布尔值 is: 判断是否为某个值，返回值为布尔值 get: 获取某个值，返回一个非布尔值 set: 设置某个值，无返回值或者返回是否设置成功 load: 加载某些数据，返回值为布尔值

1.3 常量

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

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

1.4 构造函数

介绍：在JS中，构造函数也属于函数的一种，只不过采用 new 运算符创建对象。
命名方法：大驼峰命名法，首字母大写
命名规范：前缀为名称
命名建议：无
示例：

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

1.5 类的成员

类的成员包含：
① 公共属性和方法：跟变量和函数的命名一样
② 私有属性和方法：前缀为_（下划线），后面跟公共属性和方法一样的命名方式
示例：

function Student(name){        var _name = name;        this.getName = function (){               return  this._name;    }        this.setName = function (value) {               this._name = value;    }   var st = new Student ('tom');   st.setName('jerry');   console.log(st.getName());}

2.注释规范

JS支持两种不同类型的注释，单行注释和多行注释

2.1 单行注释

说明：单行注释已两个斜线开始，以行尾结束。
语法：//这是单行注释
使用方式：
① 单独一行：//（双斜线）与注释文字之间保留一个空
② 在代码后面添加注释：//（双斜线）与代码之间保留一个空，并且//（双斜线）与注释文字之间保留一个空格
③ 注释代码：//（双斜线）与代码之间保留一个空格
示例：

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

2.2 多行注释

说明：以/开头，/结尾
语法：/* 注释说明 */
使用方法 ：
① 若开始（/）和结束（/）都在一行，推荐采用单行注释。
② 若至少三行注释时，第一行为/,最后行为/,其他以* 开始，并且注释文字与 * 保留一个空格。
示例：

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

2.3 函数（方法）注释

说明： 函数（方法）注释也是多行注释的一种，但是包含了特殊的注释要求，参照javadoc（百度百科）。
语法：
/**
* 函数说明
* @关键字
*/

常用注释关键字：（只列出一部分，并不是全部）@param: 参数名{参数类型}描述信息，示例：@param name {String} 传入名称@return: { 返回类型} 描述信息，示例： {Boolean} true :可执行;false: 不可执行@author : 作者信息 [ 附属信息：如邮箱、日期]，示例：@author 张三 2015/07/21@version ：描述此函数的版本号 ,示例：@version 1.0.3@ example :演示函数的使用，示例：@example setTiltle('测试') 

总体示例：

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

3. 框架开发

3.1 全局变量冲突

在团队开发或者引入第三方JS文件时，有时会造成全局对象的名称冲突，比如a.js 有个全局函数sendMsg() , b.js也有个全局函数sendMsg() , 引入a.js 和 b.js 文件时，会造成 sendMsg()函数冲突。

3.2 单全局变量

所创建的全局对象名称是独一无二的，并将所有的功能代码添加到这个全局对象上。调用自己所写的代码时，以这个全局对象为入口点。
如：
*JQuery的全局对象：$和JQuery
*ExtJS的全局对象： Ext
示例：

a.js 里面定义 ： var A= A || {}; A.sendMsg=function (){   alert('a');    }

3.3 命名空间

在项目规模日益壮大时，可采用命名空间方式对JS代码进行规范：即将代码按功能进行分组，以组的形式附加到单全局对象上。