命名
命名的方法通常有以下幾類:
- 命名法說明
- 1).camel命名法,形如thisIsAnApple
- 2).pascal命名法,形如ThisIsAnApple
- 3).下划線命名法,形如this_is_an_apple ·
- 4).中划線命名法,形如this-is-an-apple
說明: 所有的名稱,包括文件名都作為大小寫敏感來處理
JS
根據不同類型的內容,必須嚴格采用如下的命名法:
- .變量名:必須使用camel命名法
- .參數名:必須使用camel命名法
- .函數名:必須使用camel命名法
- .方法/屬性:必須使用camel命名法
- .私有(保護)成員:必須以下划線_開頭
- .常量名:必須使用全部大寫的下划線命名法,如IS_DEBUG_ENABLED
- .類名:必須使用pascal命名法
- .枚舉名:必須使用pascal命名法
- .枚舉的屬性:必須使用全部大寫的下划線命名法
- .命名空間:必須使用camel命名法
- .語義:命名同時還需要關注語義,如:
-
- 變量名應當使用名詞
-
- boolean類型的應當使用is、has等起頭,表示其類型
-
- 函數名應當用動賓短語
-
- 類名應當用名詞
Vue 項目中的命名
- Store 中的Module 使用 camel 命名
- Store 中的Mutation 使用 全部大寫的下划線命名法
- Store 中的state/getters/action 使用 camel 命名
- 組件必須使用pascal命名法,
- 引用組件時禁止使用別名,模板內組件標簽名遵循html 標簽命名規范,或者使用組件名
- 組件名必須避免使用Vue保留標簽名(包括HTML標簽和Vue內部標簽)
- 組件文件和組件使用相同的名字
- 前端路由路徑使用全小寫命名法
HTML
- html 文件名必須使用小寫字母
- 標簽名必須使用小寫字母
- 屬性名必須使用小寫字母
- 以上名稱有多個單詞情況下使用中划線分割
- 屬性值必須用雙引號包圍
CSS
- css 文件名必須使用小寫字母
- 選擇器必須單詞全字母小寫,多個單詞情況下使用中划線分割
- class選擇器必須代表相應模塊或部件的內容或功能,不得以樣式信息進行命名
- id 選擇器必須保證頁面唯一
- 同一頁面,應避免使用相同的 name 與 id