前端命名基本規範

 

 

資料夾命名/檔案命名

（以小橫槓（-）分隔，全部小寫沒有大寫）【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

 

---

 

注：命名中【定語】和【狀語】可以視需要新增，一般定語在主體前，狀語在主體後