前端規范之命名規則


最佳原則
堅持制定好的代碼規范。
無論團隊人數多少,代碼應該同出一門。

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');

注意!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系我们删除。



 
粤ICP备14056181号  © 2014-2021 ITdaan.com