維護程式品質的DRY與KISS原則
在設計程式的時候,相信各位或多或少會突然寫出一些有點髒的程式碼,有時候是不經意的,有時候是一時想不出方法,不得已寫出的程式碼,這篇文章將會介紹兩個簡單的開發準則,讓各位在開發的時候可以避免寫出一些日後不易閱讀的程式碼。
認識DRY
讓我們先來了解什麼是DRY,DRY分別是三個英文字的縮寫:Don’t Repeat Yourself
原因
為什麼要避免重複的程式碼出現呢?
- 重複的程式碼會讓整個scope變得很龐大
- 撰寫重複的程式碼,會消耗工程師較多的時間(時間成本)
- 重複量大的程式不易於日後閱讀與維護
優點
- 節省時間與精力
- 日後易於維護
- 減少Bug發生的可能性
認識KISS原則
KISS原則代表的意思為:Keep It Simple and Stupid
基本上的意思為,讓程式碼簡單, 清楚與容易理解。
這個原則有點開發者體驗導向(Development Experience),你可以想像一般人的記憶可能不會花太多時間在一坨程式碼上,而且人是有點惰性的生物,面對不易閱讀的東西,當然會懶得去看。
原則
- 每一個功能盡量不要撰寫過多的行數
- 每個方法只能解決一個小功能(Divide and Conquer)
- 變數命名需要邏輯清晰
迷思
有些人認為,要讓程式碼寫得好,就是要把一堆程式碼簡化到最少量為止。
這其實是一個迷思,因為你的程式碼是要給人看的,並不是給機器看。
今天你可能因為程式碼的量寫到最少量,而讓程式效率提升一定的水準,但是卻帶來日後產品維護的困擾而降低效率。
所以這邊要提醒,現今程式的開發並非以效率為主,而是以開發者體驗導向為主。
以後的科技只會讓程式越跑越好,所以效率的事情,其實是可以不用太過於擔心的。
(迷:你可能比較需要擔心網路)
All articles in this blog are licensed under CC BY-NC-SA 4.0 unless stating additionally.
Comment