10 Tips For Clean Code 整理
引言重點整理:
- 為了趕交期寫出骯髒的程式碼,產生更多臭蟲,日後改版會讓維護成本越疊越高
- 看程式碼與寫程式碼的時間比例最好落在10:1
- 花時間寫出易讀的程式碼,日後更易寫
十點建議:
- 為程式碼的品質負責,別為了交期放棄專業態度與做法
- 與其用簡短的變數加註解,不如把變數意義直接寫在變數上,好的程式碼如一篇散文,變數就是散文中的名詞
- 函數/方法宣告名稱要表達明確的意圖,不需要前後文、不用先懂他的類別就知道意思
- 註解常說謊,盡量做到程式碼即註解(CTO說這個比較有爭議性。其他文章看到頗認同的是,好的註解是寫「為什麼」,後續開發者看註解才能理解並檢討前人的動機)
- 童子軍守則(Boy Scout Rule),改善訪視過的程式碼讓他變得更好(實務上最好問一下原作:P)
- 單一功能原則(Single-responsibility Principle a.k.a. SRP):一個函數/方法/類別幾乎只做一件事,一個需要太多參數的函數可能做太多事;一個類別某些物件只用到部分性質與方法,另一些物件則用到其他的,這個類別應該拆分成多個類別
- 寫測試,分為整合性測試與單元測試,使用測試驅動開發
- 疊代式開發,用畫畫比喻,漸進/疊像是把畫中某一塊畫到完美再進行下一塊,反覆/代是先畫整張畫的草稿,再上底色,再做後續直到完美
- 軟體架構是獨立的,用來支持使用者案例,框架只是用來達成架構的工具,不是要遵循的架構,講者用WordPress舉例
- 練習,練習,再練習,台上一分鐘,台下十年功
沒有留言:
張貼留言