javascript企业级编程规范（二）

javascript企业级编程规范

1. id与class命名

• 保持 class 与 id 命名为全小写，可以使用短划线分割。例如，.btn 和 .btn-primary,可参考 bootstrap 的命名风格。
• id 和 class的命名总规则为： 内容优先, 表现为辅。
• 比如 skin-blue（皮肤蓝色）

2. 变量的命名

主要前缀有 s(string), a(Array), b(boolean), n(number),o(object),fn/pf(function), g(global全局变量),C( Component )类或结构体, m (成员变量 m_nCustomers )

• 命名可以为：变量 = 数据类型缩写 + 对象名称 + 对象描述，如：sBtnColor 按钮的颜色。
• 变量名采用小驼峰式（camelCase），如：blogTitle。
• ID在变量名中全大写 var nGoodID = 12;。
• URL在变量名中全大写 var baseURL = "http://localhost/8080/detail?page=1"。
• 常量名应全大写，用下划线连接,并用 const 关键字声明,相比 var, 更节省内存资源 const MAX_COUNT = 10。
• 构造函数，第一个字母大写,用区别于普通函数。

3. 函数的命名

函数名采用小驼峰式(camelCase)定义。避免使用单词首字母组合的方式定义。

• 对于具有返回值，且返回值不为boolean型的函数，其名称以get开头。

// 获取莫态框列表数据
function getModelList(list) {
 // 逻辑代码
}

• 对于具有返回值，且返回值为boolean型的函数，其名称可以以is、can或has开头。

function isLeafNode(node) {
    // 逻辑代码
}
function canModify(node) {
    // 逻辑代码
}
function hanSelected(selected) {
    // 逻辑代码
}

• 具有初始化功能的函数,其名称可以init或initialize开头。

// 初始化工具栏
function initToolBar() {
   // 逻辑代码
}

4. 事件的命名

• 对事件的调用函数，命名以 handle + event 格式命名(或 handle +元素+ event),或 on +元素+ event如,handleInputChange,handleBtnClick,handleInputFocus,onFocus,onBlur,onInputChange等。

• 事件处理程序提供参数写 event,可以使用ev,但是还是写全吧,单词也不长。

• 可以使用Before,After表示事件发生的时间顺序，如 onBeforeSave , onAfterSave 依然使用驼峰式camelCase 大小写命名。

• 一些事件可以用时态表示顺序，如onchange ,onChanged。

function handleInputChange() {
  // 逻辑代码,监听表单内容
}
function onBlur() {
  // 逻辑代码,失去焦点时
}
// 箭头函数也是可以的
let onBtnClick = () => {
   // 逻辑代码,点击按钮
}