(二)命名规范
命名規范
- 項目命名
- 目錄命名
- JS、CSS、SCSS、HTML、PNG 文件命名
- 命名嚴謹性
項目命名
全部采用小寫方式, 以中劃線分隔。
正例:mall-management-system
反例:mall_management-system / mallManagementSystem
目錄命名
全部采用小寫方式, 以中劃線分隔,有復數結構時,要采用復數命名法, 縮寫不用復數
正例: scripts / styles / components / images / utils / layouts / demo-styles / demo-scripts / img / doc
反例: script / style / demo_scripts / demoStyles / imgs / docs
【特殊】VUE 的項目中的 components 中的組件目錄,使用 kebab-case 命名
正例: head-search / page-loading / authorized / notice-icon
反例: HeadSearch / PageLoading
【特殊】VUE 的項目中的除 components 組件目錄外的所有目錄也使用 kebab-case 命名
正例: page-one / shopping-car / user-management
反例: ShoppingCar / UserManagement
JS、CSS、SCSS、HTML、PNG 文件命名
全部采用小寫方式, 以中劃線分隔
正例: render-dom.js / signup.css / index.html / company-logo.png
反例: renderDom.js / UserManagement.html
命名嚴謹性
代碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。 說明:正確的英文拼寫和語法可以讓閱讀者易于理解,避免歧義。注意,即使純拼音命名方式也要避免采用
正例:henan / luoyang / rmb 等國際通用的名稱,可視同英文。
反例:DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
杜絕完全不規范的縮寫,避免望文不知義:
反例:AbstractClass“縮寫”命名成 AbsClass;condition“縮寫”命名成 condi,此類隨意縮寫嚴重降低了代碼的可閱讀性。
總結
- 上一篇: document.body.scroll
- 下一篇: (五)LESS 规范