Clean Code隨筆筆記整理

-

Ch1. Clean code

好的程式碼應具有以下特質
  1. 能通過所有測試
  2. 沒有重複的程式碼
  3. 能充分表達意思
  4. 內容很短，最少量的class、Method \ Function存在
  5. 盡量少的互相依賴關係
  6. 有意義的命名，應該要光看遍數名就能懂這個變數的存在用意

Ch2. 有意義的命名

  • 請讓命名能夠展現他的意圖。
  • 不要用一些自己才知道是什麼意思的方式來命名:Image for post
  • 取名不應太過相似，要有明確區別
    reports
    report_list
    the_reports 都是複數的報告，請問誰是誰

  • 使用一些Searchable，可被IDE搜尋的到的名稱(不要跟撞名或前面掛一堆一樣的前綴增加搜尋難度或演殘選錯的機會)
  • Class和Instance不要同名
  • 用m來代表class的member前綴不是很必要，可以直接用this

  • 避免想到甚麼就打甚麼，可以的話明確定義。ex: for(int i = 0) <=可以的話就不要用i了，告訴他 i是甚麼吧

  • 變數、class、object應該使用「名詞」或名詞片語來命名
  • Function應該使用「動詞」或動詞片語來命名

  • 取名時盡量避免雙關。ex : Add就有 數學加法 和 加上、添上的意思。
    像後者的話我們可以取名為append或extend
  • 通常看你code的都會是工程師，取名以工程師看得懂為主，不需要刻意取得太過艱深。
  • 如果日常單子不足以應付取名，再以專案需求領域的專業術語單字來取名。

Ch3. Function

  • Function內容要盡量輕量短小為好
  • 一個Function只做一件事，也只做好一件事
  • 一個Function只作一個層級的事。抽象層級:
    https://www.itread01.com/content/1520062710.html
    (看起來跟作用範圍有關)

    ex: getHtml();//高層級
          String pagePathName = PathParser.render(pagePath) //中層級
          .append("\n") //低層級

  • 「由上至下閱讀原則」，由上層層級開始往下層level編寫

  • 最好的參數類型就是沒有參數
  • 如果一個function需要到兩個以上參數，可以考慮把參數包成class來傳給function

Ch4. 註解

  • 有益的註解；對意圖做解釋
  • 寫//TODO註解告訴大家有哪些事 「要做」 「還沒做」 「現狀」 及 「未來預計的狀況」
  • 同時定期刪掉已不再需要的TODO

  • 程式碼作者現在通常已經可以在git中找到，不見得需要寫成comment
  • 盡量不要註解程式碼，刪掉他保持畫面乾淨
  • 講重點，避免註解內容過多

Ch5. 編排排版

  • 垂直格式，注意空白
  • 讓換行距離成為關係緊密的依據之一，比較無關的可以隔遠一點
  • 被呼叫的function其實作內容，應該要出現在執行呼叫function的下方
  • 水平方向盡量切齊，不要拉的太長。

Ch6. 物件與資料結構

  • 資料結構 : 資料直接暴露在外，任何人都可以對其資料隨意存取。
  • class物件 : 物件內的資料可以透過private來隱藏，提供member function供大家使用

  • 程序語言 與 物件導向語言 的差別 : 
  • Procedural Code :當程序語言要加入新的或修改資料結構時會顯得比較麻煩，會有一堆function需要修改。但是加入新function顯得較為容易
  • 物件導向程式語言 : 物件導向程式語言在加入新function時顯得比較麻煩，因為class會需要被修改。但是在建立或修改class則顯得比較方便

  • 德模特爾原則 : 又稱最少知識原則。

    Class的member function A只能呼叫使用:
    1. function A自己
    2. function A所建立的東西
    3.傳給了 function A得參數
    4.Class內的data member

    就讓Class / function用他所知道的事情做事就好了，不應該讓function知道太多事情。可能像是全域變數就不太能給function用。已經超出他所知的範圍了

Ch7. 錯誤處理

  • 使用try - catch代替使用一堆if- else來抓錯誤立flag
  • 不要return null或pass null。 如果接不起來怎麼辦，可以回傳一個內容資料是空的相應物件
  • 不要把try - catch當if - else用。可以採用Design Pattern中的特殊情況模式來處理(另外開一個case來處理)

Ch8. 邊界

邊界感覺就像是自己現在的程式，與第三方程式 及 未來未知的程式， 的範圍區塊。
  • 學習式測試，知道第三方程式大概在幹嘛，如何整合進專案裡，要怎麼修改?
  • 學習式測試包含 : 邊界測試  單元測試

  • 邊界測試 : 程式在極端 / 偏門情況下會發稱什麼狀況
  • 單元測試 : 針對程式軟體模組最小單位 做 驗證的測試


  • 使用Adapter pattern模式來為「還不知道實作內容」或「未來可能會修改」的程式或第三方程式做接界到自己的程式來使用，相當於寫一個controller去控制別人的程式。除了可以作假內容方便自己開發。未來如果他人的程式修改，自己也只需要修改controller端的程式就好，本身主程式不需要大幅修改

Ch9. 單元測試

  • 測試code跟內文code一樣重要，同樣需要乾淨的維護
  • 有些有針對特定領域的測試語言，包成API來使用
  • 同樣，一個測試code一個概念

  • 整潔測試原則 : 

  • 測試執行速度要快
  • 一個測試要能獨立進行，不和其他測試相依
  • 測試在任何情況 / 環境下都能執行
  • 測試結果要能回傳bool值告訴大家是否成功，讓人清楚知道那些有過那些沒過
  • 測試先寫過，再來寫產品程式

Ch10. Class

  • class內容應該要短小
  • class的名稱應該要描述他的權責
  • class的變數應該要能盡量少。
  • class的data function應該要能用到一個以上的data member
  • 單一職責原則: 一個class只有一個權責。不要做太多事情。

  • 系統應是由多個小class構成，而不是一個巨大的class
  • 每個class封裝一個權責功能，和其他class一起完成系統

  • 修改能夠具封閉性，不會改一邊就一堆其他地方需要改。盡量不要牽一髮動全身
  • 隔離修改:Adapter pattern

Ch11.  System

先來看看別人的心得:
未提供相片說明。

QQ

留言

張貼留言

這個網誌中的熱門文章

UE4 tutorial : Getting Started

-
圖片
一些碎碎念的過程筆記，之後概念更清楚之後會再整理成一篇。 同步貼在自己的另一個blogger ------------------------------------------------------------------------------------- Getting start for Beginners https://www.raywenderlich.com/771-unreal-engine-4-tutorial-for-beginners-getting-started 安裝和視圖那些就先跳過了，這個啃一下英文或是看網頁裡的英文應該也可以有初步的認識 前情提要 Unreal真的很善待非程式開發人員，能不寫程式盡量提供不寫程式的方式，還跟app inventor很像做了一堆像連連看一樣的方式來設定邏輯。對程式出身的自己反而不是那麼習慣。 嘛，工具嘛，應該可以習慣的吧。 章節重點 Material 以前還在Shader裡面寫一堆TextureSampler去接texture圖片，然後在fragment shader裡做上色處理看是要phong lighting還是兩張texture乘起來之類的 結果unreal用拉的，酷喔 還可以串一堆以前coding很久的效果上去的樣子 Blueprints 這個感覺要講一下，如果有用過unity，應該就會知道" prefab "這個概念。Prefab是你預先製作了一個物件(gameObject)，這個物件可能包含一些自己的行為功能，或是由多個子模型組合起來。然後存起來當成一個可以被reuse或是很常用的另一個gameobject，就是Prefab(預製體)。 Unreal的Blueprints目前看起來就是在做Unity的Prefab這塊的感覺 ，不過在unity中你要有一些互動(ex:前進、旋轉) 可能就還是需要寫一個c# Script然後掛到prefab上。Unreal就是一樣繼續拉拉拉。 把兩個模型做在一起當個prefab 拉個物件旋轉套件來 旋轉target用拉的指定一下(prefab/blueprint中的成員)=>DefaultSceneRoot(全部人都給我轉起來) Event Tick:每個frame都會呼叫 ， 應該就是類似unity的...
閱讀完整內容

UE4 tutorial : Blueprints 筆記

-
圖片
先說目前心得結論。 Blueprint : Unreal提供的類Unity Prefab製作方式。而此prefab的程式component可以用類似拉線路圖拼圖的方式來組合程式互動邏輯。 ------------------------------------------ 參考教學 :  https://www.raywenderlich.com/663-unreal-engine-4-blueprints-tutorial 建立Blueprints (class)時，他會請你選擇要繼承時做的class類別 大致看下來: Actor : 所有可以被丟到world裡的都叫Actor (即便他可能是不能幹嘛的花瓶)。 Pawn : 繼承自Actor，可以被user操作和接受user input的Actor。 Character : 繼承自Pawn，自帶四處走的功能了。 Player Controller : (目前還沒用到先不講) Game Mode Base : 決定一些遊戲機制的物件 ，ex:玩家生成位置、輸入操作系統、如何進入遊戲、計分? 完成Game Mode Base設計之後， 要記得到Setting/World Setting告訴這個world你採用哪個Game Mode Base。 (其他還沒用到過所以不太清楚) 總之先設定好Game Mode Base後，同時也要設定 要產生的玩家可操作物件(Default Pawn Class) 為何。 在Scene(Unreal中稱 Level)中放入Player Strat物件，該物件會決定player一開始生成出現的位置。 設定Input 要在unreal中做輸入與互動操作並在blueprint中編輯的話，需要先到Edit\Project setting\Input中設定 在這裡建立 綁定Binding 你的輸入key資訊 :  Unreal提供兩種key binding Action Mapping : 該key只能存在兩種狀況 : "按下去"與"沒按下去"。也就是非0即1。 Axis Mapping : 有程度量的輸入。比較直觀的例子大概是PS4的蘑菇頭搖桿那樣的感覺。 這邊的例子是採用Axis Mapping來做方向行走 建立Key mapping 多增加key來...
閱讀完整內容

Unreal C++ - UPROPERTY() 及 UFUNCTION()常見設定差異

-
UPROPERTY( )   UPROPERTY(EditAnywhere) :  表示此變數可在Detail視窗 (Property Windows)變更 UPROPERTY(EditDefaultsOnly) :  表示變數僅可在Detail視窗中被修改 UPROPERTY(Category = "AAAA") :  表示此變數在grapchi與BP編輯工具中可以變顯示收納在某個分類中 UPROPERTY(BlueprintReadOnly) : 表示此變數在BP中只能被Read，不能被修改   UPROPERTY(BlueprintReadWrite) :  表示此變數在BP中可被Read可被Write UPROPERTY(BlueprintReadWrite, meta = (BindWidget)) 表示此變數和BP中某個 同名 同型別的Widget綁定，會指向同一個物件 UPROPERTY(BlueprintAssignable) 用在Delegate上，表示此Delegate可在BP中被Assign (像是Bind?) UPROPERTY(DisplayName="Property Name") 在BP上的顯示名稱，取代掉C++中宣告的名稱 UFUNCTION( ) UFUNCTION(BlueprintCallable) 表示此C++ Function可以在BP被呼叫使用 UFUNCTION(BlueprintImplementableEvent) 表示此C++Function是在BP中被實作出來的，意思是你要先去BP把他的程式邏輯拉好，然後在C++這邊送好參數去讓這個BP處理 UFUNCTION(Client, ...) 表示為Client RPC function，呼叫只在client端上執行的function UFUNCTION(Server, ...) 表示為Server RPC function，呼叫只在Server端上執行的function UFUNCTION(NetMulticast,...) 表示為Multicast RPC function，若由server端呼叫這個，則Server端與所有有這個actor的client都會執行這個function 。(詳情見UE4 RPC ...
閱讀完整內容