前端工程程式碼規範(一)——命名規則與工程約定

micherwa發表於2018-05-26

前言

隨著前端團隊人員的逐步擴大,需要有一份規範來約束程式碼的書寫。
無論人數多少,程式碼都應該同出一門。
主要參考了 騰訊alloyteam團隊,裡面有許多認同點。在此基礎上做了些許改進,為了更適合自己團隊,那些已經達成共識的程式碼習慣。僅供參考。

命名規則

總原則:全部採用小寫方式, 以中劃線分隔。

專案名
例:my-project-name

目錄名
有複數結構時,要採用複數命名法。
例:scriptsstylesimages

JS、CSS/SCSS/LESS、HTML檔名
例:ad-group.jsad-group.scssad-group.html

工程約定

一個工程內只有一個UI控制元件
以vue為例,確定使用element-ui之後,不可再引入其他ui控制元件。

工程中,src的目錄結構
assets、components、pages/views、store、service、utils、styles、libs、static

程式碼的行數與列數限制
為了提升閱讀體驗,一個檔案的行數不超過300,一行程式碼的列數不超過120
建議開啟編輯器的自動換行功能

router的定義,要對應pages中的目錄結構
例:如router為/advertise/group/list,則pages中的目錄應為advertise->group->list

元件的傳值
保持單一資料流,公用元件需有一個index檔案進行統一註冊

css的預編譯器
採用less或者sass,非兩者混用

變數申明
儘可能少用var,習慣使用let和const

不要使用eval
出於安全性考慮

一個工程內,所有檔名小寫,以‘-’的形式聯結
例:components/ad-group.vue、services/create-ad-service.js

import的變數名,首字母大寫,並採用駝峰形式
例:
import AdGroup from @/components/ad-group.vue;
import CreateAdService from @/services/create-ad-service;

目錄索引

前端工程程式碼規範(二)——HTML
前端工程程式碼規範(三)——CSS, SCSS
前端工程程式碼規範(四)——JS


相關文章