簡介
前端開發規範手冊(命名、HTML、CSS、JS、ES6、React)完整連結,歡迎給出您的寶貴意見;
GitHub原始碼地址,要是覺得文件還能湊合著看,歡迎 star
~
本文首發於我的個人部落格:blogs.niceboybao.com/
不以規矩,不能成方圓。 對於團隊而言,統一很重要,程式碼是寫給人看的,然後順便跑在機器上而已。
有過憂慮嗎
你是不是總是在抱怨專案組的各方面不統一,不好維護,千奇百怪?
你是不是每次提交程式碼的時候總要拉某某人過來看下各種衝突?
你是不是每次merge程式碼的時候總要話很長的時間去解決不同格式的程式碼衝突?
你是不是有時候為了解決一個bug好幾天沒睡好,最終定位的問題也許是一個分號、或是書寫規範? 人人都在恐慌,人人都在責怪他人,但殊不知,換了好幾個專案都是類似,想過為什麼嗎?
規範的意義
每一種事物都有它被髮明時,都會有其用處和目的,每一個事物都是自己擅長和適合的領域; 我們要在對的地方使用它,讓它做自己擅長的事。
- 規範的程式碼可以促進團隊合作;
- 規範的程式碼可以減少bug處理;
- 規範的程式碼可以降低維護成本;
- 規範的程式碼有助於程式碼審查;
- 養成程式碼規範的習慣,有助於程式設計師自身的成長;
規範的目的
我們知道,當一個團隊開始指定並實行編碼規範的話,錯誤就會變得更加顯而易見。 如果一段特定的程式碼不符合規範的話,它有可能只是程式碼風格錯誤,而也有可能會是 bug。 早期指定規範就使得程式碼稽核得以更好的開展,並且可以更精確的地定位到錯誤。 只要開發者們能夠保證原始碼原始檔都嚴格遵循規範,那接下去所使用的混淆、壓縮和編譯工具則可投其所好不盡相同。 為了提高工作效率,便於後臺人員新增功能及前端後期優化維護,輸出高質量的文件。 在專案構建中,使結構更加清晰,程式碼簡明有序,有一個更好的前端架構。
介紹
工程架構基於 vuepress
搭建而成,原始碼地址github.com/niceboybao/…,如有問題請點選New Issue,歡迎 push
相關內容加入貢獻者行列,要是覺得文件還能湊合著看,歡迎 star
~
文件編寫參考多個熱門的前端開源規範參考,並結合個人專案總結而成。專案 快速預覽圖
如下:
參考文件
- 使用Doctype啟用瀏覽器模式
- AMD 和 CMD 的區別有哪些?
- AMD規範與CMD規範的區別
- airbnb JavaScript Style Guide
- airbnb JavaScript Style Guide中文版
- 通過分析github程式碼庫總結出來的工程師程式碼書寫習慣
- 「掘金」前端開發規範:命名規範、html規範、css規範、js規範
- 編碼規範 by @mdo
- Max Yu javascript編碼規範
- Max Yu CSS編碼規範
- 前端編碼規範之JavaScript
- 網易前端開發規範-css規範-html規範-工程師規範
- Baidu EFE team 前端開發規範大全(包括react.js規範)
- 前端架構之路(3) - 前端開發規範
- 騰訊前端IMWEB團隊社群
- 前端編碼規範(4)- CSS 和 Sass (SCSS) 規範
- JavaScript 開發規範