《Clean Code》標註

《Clean Code》標註

函數

• 函數要麼作什麼事，要麼回答什麼事，但兩者不可得兼，函數應該修改某對象的狀態，或是返回該對象的有關信息
• Try/catch 代碼塊醜陋不堪。他們搞亂了代碼結構，把錯誤處理與正常流程混爲一談。最好把 try 和 catch 代碼塊的主體部分抽離出來，另外造成函數。

註釋

• 別給糟糕的代碼加註釋 ---- 從新寫吧
• 用整理代碼的決心替代創造廢話的衝動吧。你會發現本身成爲更優秀、更快樂的程序員。

格式

• 關係密切的概念應該互相靠近。顯然，這條規則並不適用於分佈在不一樣文件中的概念。除非有很好的理由，不然就不要把關係密切的概念放到不一樣的文件中。
• 相關函數。若某個函數調用了另一個，就應該把它們放到一塊兒，並且調用者應該儘量放在被調用者上面。這樣，程序就有個天然的順序。
• 概念相關。概念相關的代碼應該放到一塊兒。相關性越強，彼此之間的距離就應該越短。
• 賦值操做的周圍加上空格字符，以此達到強調目的。賦值語句有兩個肯定而重要的要素：左邊和右邊。空格字符增強了分隔效果
• 把函數調用括號中參數一一隔開，強調逗號，表示參數是互相分離的。

錯誤處理

• 當你打包一個第三方 API，你就下降了對它的依賴：將來你能夠不太痛苦地改用其餘的代碼庫。在你測試本身的代碼時，打包也有助於模擬第三方調用。

味道與啓發

• 術語「魔術數」不只是說數字。它泛指任何不能自我描述的符號。
• 函數中的語句應該是在同一抽象層級上，該層級應該是函數名所示操做的下一層。這多是最難理解和遵循的啓發。
• 得墨忒耳律。The Pragmatic Programmers 稱之爲「編寫害羞代碼」。二者都歸結爲確保模塊只瞭解其直接協做者，不瞭解整個系統的遊覽圖。
• 正確的作法是讓直接協做者提供所需的所有服務。沒必要逛遍系統的對象全圖，搜尋咱們要調用的方法。