自我總結代碼規範，歡迎修正

1. 函數塊不要太長，太長影響閱讀，一個函數作一件事
2. 避免冗餘代碼和重複代碼
3. 一個文件作一件事， 整個文件代碼不能太長，保持在300~500行之內
4. 不要提交直接執行的console.log信息，影響它人調試
5. 不要提交沒用的註釋代碼，影響閱讀和開發，若是要查看能夠進行版本歷史

個人代碼規範原則

• 影響閱讀的代碼，那就是很差代碼
• 不少很類似的代碼，那必定是重複冗餘了

如下是最近在某代碼倉庫js中發現不規範的代碼，固然還有css規範了，有興趣的能夠本身上網搜索

代碼規範和不規範舉例

函數塊不要太長，太長影響閱讀，一個函數作一件事

• 太長的函數塊:建議函數塊以編輯器的一屏爲準，幾乎不用滾動條能夠看完整個函數
• 能夠看到這裏的函數每行30行至更多。打開後必須滾動條才能看清楚這個函數

• 改良後的函數塊
• 一個函數平均10-20行之間

避免冗餘代碼和重複代碼

• 冗餘代碼示例
• 若是你發現了不少地方代碼很類似，那確定是代碼重複冗餘了

• 改良後冗餘代碼示例
• 發現重複和冗餘的規律，統一用函數封裝起來

一個文件作一件事， 整個文件代碼不能太長，保持在300~500行之內

• 文件代碼結構劃分
• 一個method能夠拆分紅文件夾，經過index入口導入
• 一個文件作一件事，能夠看到一個文件纔不到200行
• 還有文件順序問題，好比vue鉤子函數，建議不用把created寫在最後

• 文件夾結構
• 公共的css提出來
• 公共的方法用mixin提出來

不要提交直接執行的console.log信息，影響它人調試

• 及時運行的log信息
• 寫代碼的時候能夠用，提交儘可能不要提交console.*信息

• 雜亂的log控制檯

不要提交沒用的註釋代碼，影響閱讀和開發，若是要查看能夠進行版本歷史

• 不要提交註釋代碼可在版本歷史查看

• 版本歷史

一塊兒努力吧

--
做者：劉偉波

連接：http://www.liuweibo.cn/p/252

來源：劉偉波博客

本文原創版權屬於劉偉波 ，轉載請註明出處，謝謝合做