前端规范之命名规则

最佳原则

坚持制定好的代码规范。

无论团队人数多少，代码应该同出一门。

1.项目命名

全部采用小写方式， 以下划线分隔。

例：my_project_name

2.目录命名

参照项目命名规则；

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

例：scripts, styles, images, data_models

3.JS文件命名

参照项目命名规则。

例：account_model.js

4.CSS, SCSS文件命名

参照项目命名规则。

例：retina_sprites.scss

5.HTML文件命名

参照项目命名规则。

例：error_report.html

6.css,sass,less的类名和Id命名

• 类名使用小写字母，以中划线分隔；
  eg: .my-first-name
  
  
• id采用驼峰式命名; 
  eg: #myFirstName
  
  
• sass,less中的变量、函数、混合、placeholder采用驼峰式命名; 
  eg: $mainWidth, #mainHeight

7.JS中变量命名

• 标准变量采用驼峰式命名（除了对象的属性外，主要是考虑到cgi返回的数据）
  eg: var myFirstName
  
  
• 'ID'在变量名中全大写
  eg: var goodID;


• 'URL'在变量名中全大写
  eg: var reportURL;


• 'Android'在变量名中大写第一个字母
  eg:var AndroidVersion;


• 'iOS'在变量名中小写第一个，大写后两个字母
  eg:  var iOSVersion;


• 常量全大写，用下划线连接
  eg: var MAX_INDEX = 1;
  
  
• 构造函数，大写第一个字母
  function Person(name) {
    this.name = name;
}


• jquery对象必须以'$'开头命名

          // not good

          var body = $('body');

          // goodvar

          $body = $('body');