如何編寫高質量代碼

更多文章

什麼是高質量代碼?

高質量代碼具備如下幾個特色：

• 可讀性高
• 結構清晰
• 可擴展（方便維護）
• 代碼風格統一
• 低複雜性
• 簡練

編寫高質量代碼主要遵循如下幾點：

代碼規範

代碼規範的好處

• 規範的代碼能夠促進團隊合做
• 規範的代碼能夠下降維護成本
• 規範的代碼有助於代碼審查
• 養成代碼規範的習慣，有助於程序員自身的成長

每一個程序員最煩的就是修改別人的代碼，不管代碼好壞。由於第一眼看上去沒有熟悉感，下意識就會排斥。
因此當團隊的成員都嚴格按照代碼規範來寫代碼時，能夠保證每一個人的代碼看起來都像是一我的寫的，看別人的代碼就像是在看本身的代碼。
重要的是咱們可以認識到規範的重要性，並堅持規範的開發習慣。

接下來，你要作的事就是找一份良好的代碼規範並一直堅持使用，直到造成習慣。

前端代碼規範推薦

• 百度前端代碼規範
• feross/standard · GitHub
• Airbnb JavaScript Style Guide

提早設計

在接到一個需求時，千萬不要看完需求就立刻寫代碼，以避免形成返工或誤解需求的現象。在這個階段必定要多問，看完需求後，在腦裏過一下，把可能會涉及的狀況都要問清楚。
一名好的程序員不只僅是一名程序員，還要懂需求、業務。
在把狀況都瞭解清楚後，若是項目規模不是很大，就能夠開始寫大綱了。
例如這樣：

class Car {
  run(){},
  stop(){},
}
複製代碼

而後再開始實現細節。

若是項目規模比較大，能夠經過思惟導圖或其餘工具寫一個項目的原型（固然這種活通常都會由項目經理或產品來負責），再細分到不一樣的程序模塊來一一實現。

「磨刀不誤砍柴功」，千萬不要爲了求快而直接寫代碼。

具體流程

• 閱讀文檔，分析需求
• 畫原型圖或草圖（方便本身理解總體架構）
• 寫大綱或僞代碼（若是項目比較大還要細分模塊）
• 實現細節

重構

沒有程序員能一次就寫出完美的代碼，而是須要經過不停的重構來完善代碼，提高質量。
重構就是在不改變軟件系統外部行爲的前提下，改善它的內部結構。
重構可使軟件更容易地被修改和被理解。經過不斷地改進軟件設計以達到簡單設計的目標，減小因爲設計與業務的不匹配帶來的架構與設計腐化。

• 重構能改善軟件設計
• 重構使軟件更易理解
• 重構有助於找到Bug
• 重構有助於提升自我編程能力
• 重構有助於加深理解代碼
• 重構能適應需求變動

推薦閱讀：重構

代碼要求

• 不要編寫大段代碼
• 重複代碼封裝成函數
• 在編寫代碼的過程當中養成不斷重構的習慣
• 添加必要的註釋
• 留下可擴展的空間

測試

不管是單元測試、自測或者是其它測試，最重要的目的都是爲了找出儘量多的BUG，保證產品的質量。
好的東西都是迭代改出來的，好比好的產品，好的架構，代碼也不例外，寫的好的代碼都是經歷了做者不停地 review 和修改。
測試的過程自己就是一個自我 code review 的過程，在這個過程當中，能夠發現一些設計上的問題(好比代碼設計的不可測試)，代碼編寫方面的問題(好比一些邊界條件的處理不當)等，作到及時發現及時修正，不須要等到測試階段甚至上線以後再發現再修改。

自我要求

我的認爲這一點是最重要的，好的程序員都是有強迫症的，他們會嚴格要求本身，經過不斷的學習來提高本身的技術最終成爲大神級別的程序員。
若是你不能以高標準來要求本身，即便你看再多的如何寫出高質量代碼，懂再多的代碼規範，也是沒有用，最終仍是會寫出低質量代碼。
可是，提升自我要求是一種改變，通常來講，改變都不是一蹴而就的，須要一步一步來。因此，改變最好從小事作起，慢慢積累，最終蛻變。
建議先從代碼規範開始，熟悉代碼規範，遵循規範寫代碼，直到成爲習慣，而後再學習其它方法，最終寫出高質量代碼。

參考資料

• kdboy.iteye.com/blog/407572
• www.jianshu.com/p/71ad60844…