讀書心得 - Clean Code - Chapter 4

Chapter 4 - 註解

不要替糟糕的程式碼寫註解 - 重寫它

    註解為必要之惡，用來彌補我們用程式碼表達意圖失敗的狀況。註解在絕大多數的情況無法跟著程式演進，導致過時且偏離當初的程式碼解釋。最後的真相只會存於程式碼。

有益的註解

    法律型的註解

    // Copyright 2011-2019 The Bootstrap Authors
    // Copyright 2011-2019 Twitter, Inc.

    資訊型註解

    資訊型註解提供一些基本資訊，但還是很容易被好的程式碼命名給取代

     // Returns an instance of the Responder being tested.
     protected abstract Responder responderInstance();

    對意圖的解釋

     // This is our best attempt to get a race condition
     // by creating large number of threads.

    對後果的告誡

     // Don't run unless you
     // have some time to kill

     // SimpleDateFormat is not thread safe,
     // so we need to create each instance independently

上一篇：
讀書心得 - Clean Code - Chapter 3 (2)
下一篇：
讀書心得 - Clean Code - Chapter 5