命名规则

项目命名

全部采用小写方式， 以下划线（_）或破折号（-）连接单词

注：库文件可用逗点（.），用于体现版本或从属关系

例：my_project_name

目录命名

参照项目命名规则；

有复数结构时，要采用复数命名法。

例：scripts, styles, images, data_models

JS文件命名

参照项目命名规则。

例：account_model.js

CSS, SCSS文件命名

参照项目命名规则。

例：retina_sprites.scss

HTML文件命名

参照项目命名规则。

例：error_report.html

Demo

• vue.min.js
• vue-router.js
• jquery.form.js
• jquery-1.4.2.min.js

变量命名

[强制] 变量 使用 Camel命名法。

示例：

var loadingModules = {};

[强制] 常量 使用 全部字母大写，单词间下划线分隔 的命名方式。

示例：

var HTML_ENTITY = {};

[强制] 函数 使用 Camel命名法。

示例：

function stringFormat(source) {
}

[强制] 函数的 参数 使用 Camel命名法。

示例：

function hear(theBells) {
}

[强制] 类 使用 Pascal命名法。

示例：

function TextNode(options) {
}

[强制] 类的 方法 / 属性 使用 Camel命名法。

示例：

function TextNode(value, engine) {
    this.value = value;
    this.engine = engine;
}

TextNode.prototype.clone = function () {
    return this;
};

[强制] 枚举变量 使用 Pascal命名法，枚举的属性 使用 全部字母大写，单词间下划线分隔 的命名方式。

示例：

var TargetState = {
    READING: 1,
    READED: 2,
    APPLIED: 3,
    READY: 4
};

[强制] 命名空间 使用 Camel命名法。

示例：

equipments.heavyWeapons = {};

[强制] 由多个单词组成的缩写词，在命名中，根据当前命名法和出现的位置，所有字母的大小写与首字母的大小写保持一致。

示例：

function XMLParser() {
}

function insertHTML(element, html) {
}

var httpRequest = new HTTPRequest();

[强制] 类名 使用 名词。

示例：

function Engine(options) {
}

[建议] 函数名 使用 动宾短语。

示例：

function getStyle(element) {
}

[建议] boolean 类型的变量使用 is 或 has 开头。

示例：

var isReady = false;
var hasMoreCommands = false;

[建议] Promise对象 用 动宾短语的进行时 表达。

示例：

var loadingData = ajax.get('url');
loadingData.then(callback);