函數設計的四個原則

原則1 函數設計要盡量短小,嵌套層次不宜過深。所謂短小,就是跟前面所提到的一樣盡量避免過長函數,因為這樣不需要上下拉動滾動條就能獲得整體感觀,而不是來回翻動屏幕去尋找某個變量或者某條邏輯判斷等。函數中需要用到if、elif、while、for等循環語句的地方,盡量不要嵌套過深,最好能控制在3層以內。相信很多人有過這樣的經歷:為了弄清楚哪段代碼屬于內部嵌套,哪段屬于中間層次的嵌套,哪段屬于更外一層的嵌套所花費的時間比讀代碼細節所用時間更多。

原則2 函數申明應該做到合理、簡單、易于使用。除了函數名能夠正確反映其大體功能外,參數的設計也應該簡潔明了,參數個數不宜太多。參數太多帶來的弊端是:調用者需要花費更多的時間去理解每個參數的意思,測試人員需要花費更多的精力來設計測試用例,以確保參數的組合能夠有合理的輸出,這使覆蓋測試的難度大大增加。因此函數參數設計最好經過深思熟慮。

原則3 函數參數設計應該考慮向下兼容。實際工作中我們可能面臨這樣的情況:隨著需求的變更和版本的升級,在前一個版本中設計的函數可能需要進行一定的修改才能滿足這個版本的要求。因此在設計過程中除了著眼當前的需求還得考慮向下兼容。

原則4 一個函數只做一件事,盡量保證函數語句粒度的一致性。如本節開頭所示代碼中就有3個不同的任務:獲取網頁內容、查找指定網頁內容、發送郵件。要保證一個函數只做一件事,就要盡量保證抽象層級的一致性,所有的語句盡量在一個粒度上。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。