这篇文章主要介绍的是关于JS的命名规范、注释规范以及框架开发的一些问题，首先来看看目录。

一、命名规范

驼峰式命名法介绍：

驼峰式命名法由小(大)写字母开始，后续每个单词首字母都大写。

按照第一个字母是否大写，分为：

① Pascal Case 大驼峰式命名法：首字母大写。eg：StudentInfo、UserInfo、ProductInfo

② Camel Case 小驼峰式命名法：首字母小写。eg：studentInfo、userInfo、productInfo

1.1 变量

命名方法

：小驼峰式命名法。

命名规范

：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数)

命名建议

：尽量在变量名字中体现所属类型，如:length、count等表示数字类型；而包含name、title表示为字符串类型。

示例：

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

1.2 函数

命名方法

：小驼峰式命名法。

命名规范

：前缀应当为动词。

命名建议

：可使用常见动词约定

函数返回一个布尔值。true：可执行；false：不可执行函数返回一个布尔值。true：含有此值；false：不含有此值函数返回一个布尔值。true：为某个值；false：不为某个值获取某个值函数返回一个非布尔值

示例：

// 获取名称
function getName() {
return this.name;
}

1.3 常量

命名方法

：名称全部大写。

命名规范

：使用大写字母和下划线来组合命名，下划线用以分割单词。

命名建议

：无。

示例：

1.4 构造函数

介绍

：在JS中，构造函数也属于函数的一种，只不过采用new 运算符创建对象。

命名方法

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

命名规范

：前缀为名称。

命名建议

：无。

示例：

var st = new Student('tom');

1.5 类的成员

类的成员包含：

① 公共属性和方法：跟变量和函数的命名一样。

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

示例：

// 公共方法
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私有变量的值

二、注释规范

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

2.1 单行注释

说明

：单行注释以两个斜线开始，以行尾结束。

语法

：// 这是单行注释

使用方式：

① 单独一行：//(双斜线)与注释文字之间保留一个空格。

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

③ 注释代码：//(双斜线)与代码之间保留一个空格。

示例：

调用了一个函数；1)单独在一行 setTitle();

var maxCount = 10; // 设置最大量；2)在代码后面注释

// setName(); // 3)注释代码

2.2 多行注释

说明

：以/*开头，*/结尾

语法

：/* 注释说明 */

使用方法：

① 若开始(/*)和结束(*/)都在一行，推荐采用单行注释。

② 若至少三行注释时，第一行为/*，最后行为*/，其他行以*开始，并且注释文字与*保留一个空格。

示例：

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

2.3 函数(方法)注释

说明：

函数(方法)注释也是多行注释的一种，但是包含了特殊的注释要求，参照 javadoc(百度百科)。

语法：

函数说明 * @关键字 */

常用注释关键字：(只列出一部分，并不是全部)

名称函数作者的信息函数的版本号代码函数的使用

示例：

| | 张三 | * ----------------- - 18 --------- * | 18 | 王五 | | | 王五 | * ----------------- ----------------- */ function mergeCells(grid,cols,isAllSome) { // Do Something }