《代碼整潔之道》總結——函數

来源:http://www.cnblogs.com/taojinxuan/archive/2017/07/16/7191711.html
-Advertisement-
Play Games

函數要短。短才方便閱讀、維護和設計。 函數只做一件事。依照單一職責原則(一個類只會因為一個原因改變)設計函數。一個函數要麼進行流程式控制制或邏輯判斷,要麼改變某事物的狀態,要麼計算並返回結果,要麼調用多個下一抽象級的其他函數(另一種流程式控制制而已)。不要有多餘功能。 我們可以把函數分解成多個抽象層級來設計 ...


  1. 函數要短。短才方便閱讀、維護和設計。
  2. 函數只做一件事。依照單一職責原則(一個類只會因為一個原因改變)設計函數。一個函數要麼進行流程式控制制或邏輯判斷,要麼改變某事物的狀態,要麼計算並返回結果,要麼調用多個下一抽象級的其他函數(另一種流程式控制制而已)。不要有多餘功能。
  3. 我們可以把函數分解成多個抽象層級來設計,在調用時最好只同時調用同一層級的函數,依照倒樹狀圖來設計函數。個人認為類似於面向過程編程的思想。在使用時,同一層級的操作可以分解為多個小函數,前一動作函數操作完成後,去調用後一動作的函數,一次鏈接,完成一個層級的操作。
  4. 函數不應該有作為標識的參數,這意味著函數有至少兩種執行方式違反了第2條原則。
  5. 函數參數最多有兩個,除非多個參數是作為一個整體傳入的。如:坐標系的x,y,z作為一個整體。並且這種多個參數構成的整體最好能封裝成類來傳入。
  6. 函數真的最好只做一件事,不要在函數里為了方便當前調用加入其它功能。如web登錄驗證時,函數用來驗證username和password,在驗證之後順便初始化session,這會導致除了登錄時能調用驗證函數,其它時候這函數沒有任何作用或者強制刷新了session導致未知錯誤。
  7. 不要有輸出參數,如果想改變某類的狀態,就把該函數加入該類,讓它自己調用函數。如:把改變類x的狀態的函數調用addFooter(x),改為x.addFooter()。
  8. 函數不要返回錯誤碼,這需要你有錯誤碼的枚舉類,並且違反了開放封閉原則(你需要加入新錯誤碼來擴展新錯誤),直接拋出異常就好了。(可以通過繼承父異常來擴展)
  9. 最好用函數名稱就描述清楚函數作用,避免頻繁去看函數文檔,這對於短小的函數來說不難辦到,如果很難命名可能需要思考函數是否有依照以上原則設計。並且名稱的命名應該不容易與其他函數名稱形成混淆。如:add()在calculator中意思是加,而在List中就不應該用add表示插入集合了,應該用insert或append。簡單來說就是一個概念對應一個詞,並且始終如一。

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 三木運算,三元運算 name = 值1 if 條件 else 值2 深拷貝淺拷貝 str創建一個值不能修改,如果修改在,創建一個 對於int和str 賦值,深拷貝,淺拷貝地址是不變的 對於dict,list,tup 淺拷貝僅拷貝最外層 深拷貝是除了最內層都拷貝 函數 動態參數 萬能參數 *arges ...
  • MultiProcessing模塊是一個優秀的類似多線程MultiThreading模塊處理併發的包 之前接觸過一點這個庫,但是並沒有深入研究,這次閑著無聊就研究了一下,算是解惑吧。 ...
  • 歐拉篩素數: 時間複雜度:O(n) 主要思路:對於每一個合數,讓他的最大的約數把他篩去 ...
  • 題目鏈接 DESCRIPTION INPUT 題目鏈接 DESCRIPTION INPUT INPUT INPUT OUTPUT OUTPUT SAMPLE INPUT 1 4 2 1 2 5 2 3 5 3 4 5 5 5 SAMPLE INPUT 1 4 2 1 2 5 2 3 5 3 4 5 ...
  • 位運算符 &與 |或 ^異或 <<左移 >>右移 >>>無符號右移 ~取反 註意:位運算是針對整數運算的 int i = 6,j = 10; 方式一:利用第三方變數 int k = i; i = j; j = k; 方式二:利用加減法 i = i + j; j = i - j; >j = i + j ...
  • 2017-07-15,這是我學習python的第一天。 首先,python是一門當下很火熱的開發語言,它的創始人是Guido Van Rossum。就目前情況而言,python語言的熱度持續上升,已經超過C#排名第四。Python崇尚優美,簡潔,清晰,是一種優秀並且廣泛使用的語言。 一、Python ...
  • 十進位轉成十六進位: Integer.toHexString(int i) 十進位轉成八進位 Integer.toOctalString(int i) 十進位轉成二進位 Integer.toBinaryString(int i) 十六進位轉成十進位 Integer.valueOf("FFFF",16 ...
  • 金庸經典《射雕英雄傳》里,黃蓉為了讓洪七公交自己和靖哥哥武功,天天對師傅美食相待,在做了“玉笛誰家聽落梅”這樣一些世間珍品之後,告訴師傅說今天要做的是"炒白菜"。洪七公露出非常欣賞的眼光,說:“好,我倒要看看你怎樣化腐朽為神奇。”上周五聽了一個我們內部的深度學習講座,基本這方面處於初始探索階段。上周 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...