JavaScript规范-详细内容 - 黄兵的个人博客

文章内容

2017/7/24 16:00:00,作者: 黄兵

JavaScript规范

1 前言: 本文档的目标是使javaScript代码风格保持一致，容易被理解和被维护。

2 文件

2.1 文件编码

建议： JS 文件使用无 BOM 的 UTF-8 编码。

解释：UTF-8编码具有更广泛的适应性。BOM在使用程序或工具处理文件时可能造成不必要的干扰。

2.2 文件名

强制：创建 JS 文件名要语义化。

解释：好的语义化文件名，方便查找。用单词命名，多个单词用"_"下划线拼接。

示例：

index.js //首页
article.js //文章
details.js //详情
personal_member.js  //个人会员
business_member.js  //商户会员

3 代码风格

3.1 命名

建议： JS 命名要语义化。

解释：好的语义化命名，方便查找。变量名、函数名、对象名尽量用单词、缩写、驼峰式语义化命名。

//变量名
var userName;

//函数名
function userName() {	
}

//对象名
var userName = {};

3.2 缩进

强制：使用 4 个空格做为一个缩进层级，不允许使用 2 个空格。

示例：

function userName() {
    alert('hello world');
}

3.3 空格

强制：以下示例、等其他代码必须包含空格。

示例：

//变量
var age = 28;

//函数
function age() {	
}

//对象
var age = {};

//IF语句
if (age > 3) {	
} else {	
}

//FOR循环语句
for (var i in arr) {	
}

强制：属性名与之后的 : 之间不允许包含空格， : 与属性值之间必须包含空格。

示例：

var object = {
    name: '张三',
    age: '26,
}

3.4 函数

强制：带参数的函数，要声明注释。

示例：

/**
 * 格式化PHP时间戳
 * @author Sea 
 * @param {function} formatTime
 * @param {int} time 时间戳
 * @param {string} format 格式
 * @return {int}
 * @date 2016-06-16
 */
function formatTime(time, format) {
    var today = new Date(time * 1000);
    var y = today.getFullYear();
    var m = (today.getMonth()+1 < 10) ? '0'+(today.getMonth()+1) : (today.getMonth()+1);
    var d = (today.getDate() < 10) ? '0'+today.getDate() : today.getDate();
    var h = (today.getHours() < 10) ? '0'+today.getHours() : today.getHours();
    var i = (today.getMinutes() < 10) ? '0'+today.getMinutes() : today.getMinutes();	
    var time = null;
    
    if (format == 'y-m-d h:i') {
        time = y+'-'+m+'-'+d+' '+h+':'+i;
    } else if(format == 'y-m-d') {
        time = y+'-'+m+'-'+d;
    }
    
    return time;
}