前端命名基本规范

前端命名基本规范

 

 

文件夹命名/文件命名

（以小横杠（-）分隔，全部小写没有大写）【windows下大小写不敏感】

 

---

 

字段命名

• 变量字段【驼峰】命名

属性类 [主体...][属性][状态(可选)]

• [container][size] => containerSize
  • [container][size][old/new] => containerSizeOld/containerSizeNew

 

表述主体类 [定语][主体]

• [node][list] => nodeList

 

状态类

• 进行中 is[状态名]  (视图绑定中一般用is更多)
• is[runing] => isRunning
• 为了描述清楚主体也可在中间添加主体名
  • is[rabbit][running] => isRabbitRunning

• 完成状态 has[状态名]
• has[done] => hasDone

 

• 不可变量 【全部大写】，字母间用下划线（_）分隔

• 词性可参考变量的命名
  • const DEFAULT_MODE = "open";
  • const IS_MOCK = false;

---

方法命名

• 实例方法，【驼峰】命名

内部调用方法

• [动作][对象]
• [open][video] => openVideo
  • [init][chart] => initChart

 

外部调用方法，因为是外部调用，所以作用对象（就是自己）已经有了，所以对象可以忽略

• [动作]
• [打开open] =>  video.open()

 

事件回调方法

• on[事件名]
• on[resize] => onResize

 

---

 

注：命名中【定语】和【状语】可以视需要添加，一般定语在主体前，状语在主体后