代碼規範
git commit
規範
每次提交 git commit
的時候總是有點難受,不知道怎麼寫?
還有不同人寫的風格完全不一樣,
1.安裝Commitizen
npm install -g commitizen
https://github.com/commitizen...
2.項目運行命令行
commitizen init cz-conventional-changelog --save --save-exact
凡是用到git commit
命令,一律改爲使用git cz
這時,就會出現選項,用來生成符合格式的 Commit message
還有一些其他安裝方式,具體參考上面鏈接的文檔即可.
代碼規範
Airbnb 代碼規範 https://github.com/airbnb/jav...
eslint 代碼檢查 https://cn.eslint.org
korofileheader 註釋生成 https://marketplace.visualstu...
凹凸實驗室代碼規範 https://guide.aotu.io/index.html
react 代碼規範 https://github.com/airbnb/jav...
vue 代碼規範 https://cn.vuejs.org/v2/style...
命名規則
Pascal Case 大駝峯式命名法:首字母大寫。eg:StudentInfo、UserInfo、ProductInfo
Camel Case 小駝峯式命名法:首字母小寫。eg:studentInfo、userInfo、productInfo
函數命名規則
動詞 | 含義 | 返回值 | |
---|---|---|---|
can | 判斷是否可執行某個動作(權限) | 函數返回一個布爾值。true:可執行;false:不可執行 | |
has | 判斷是否含有某個值 | 函數返回一個布爾值。true:含有此值;false:不含有此值 | |
is | 判斷是否爲某個值 | 函數返回一個布爾值。true:爲某個值;false:不爲某個值 | |
get | 獲取某個值 | 函數返回一個非布爾值 | |
set | 設置某個值 | 無返回值、返回是否設置成功或者返回鏈式對象 | |
load | 加載某些數據 | 無返回值或者返回是否加載完成的結果 |
輔助命名codelf
https://unbug.github.io/codelf/
一個輔助命名的網站, 也有VS Code
插件擴展,取名的時候時間比較實用