Clean Code

讓你的Code 更乾淨🧹 Johnny Lin @Anue Tech Sharing, 2022/09/07

1. Clean Code 2. 命名 3. 函式 4. 註解 Outline

什麼是Clean Code? 優雅、簡單、明瞭沒有重複的程式碼能通過所有的測試較少的相依性

Why Clean Code?

閱讀程式碼、寫程式時間比例 -> 10:1

閱讀程式碼、寫程式時間比例 -> 10:1 花時間寫更簡潔的Code >> 日後閱讀與維護

閱讀程式碼、寫程式時間比例 -> 10:1 花時間寫更簡潔的Code >> 日後閱讀與維護 Clean Code is IMPORTANT

有意義的命名

微小差距的名稱: XYZControllerForEfficientHandlingOfString XYZControllerForEfficientStoreageOfString 避免誤導

同時使用小寫L 、大寫O 當變數名稱避免誤導

IShapeFactory 與ShapeFactory: 多餘的I 字首簡短且有力、避免多餘的單詞命名

IShapeFactory 與ShapeFactory: 多餘的I 字首 accountData 與account: 多餘的Data 單詞簡短且有力、避免多餘的單詞命名

讓名稱代表意圖

函式

「關於函式的首要準則，就是要簡短。第二項準則，就是要比第一項的簡短函式還要更簡短。」簡短!

僅兩行、三行或四行每個函式帶領你到下一個函式「關於函式的首要準則，就是要簡短。第二項準則，就是要比第一項的簡短函式還要更簡短。」簡短!

Single Responsibility Principle(SRP) 「函式應該只做一件事。它們應該把這件事做好。而且他們只做這件事。」只做一件事

Single Responsibility Principle(SRP) 「函式應該只做一件事。它們應該把這件事做好。而且他們只做這件事。」如何判斷? 只做一件事

A module should have one, and only one reason to
change. Single Responsibility Principle(SRP) 「函式應該只做一件事。它們應該把這件事做好。而且他們只做這件事。」如何判斷? 只做一件事

A module should have one, and only one reason to
change. 如果我們以文字的方式描述一個函式，看到其中包含了「不同層次」的抽象概念步驟，就可以判斷這個程式包含了不只一件事。 Single Responsibility Principle(SRP) 「函式應該只做一件事。它們應該把這件事做好。而且他們只做這件事。」如何判斷? 只做一件事

One thing

1. 判斷此頁面是否為測試頁面 2. 如果是測試頁面的話，則納入設定與拆解步驟 3. 將此頁面轉換為HTML 網頁

一件事還是三件事?

判斷此頁面是否為測試頁面如果是測試頁面的話，則納入設定與拆解步驟將此頁面轉換為HTML 網頁 TO RenderPageWithSetupsAndTeardowns 一件事還是三件事?

生活中的例子: 洗澡只做一件事

「將flag 變數傳遞給函式，等於大聲宣布此函數做超過一件事。」 - Uncle Bob flag 參數

try 開頭，catch/finally 結尾，不含有其他程式碼「函式只做一件事，而錯誤處理就是一件事」錯誤處理就是一件事

程式變得擁擠重複的改變，倍數增長的工時避免重複的程式碼不要重複自己 Don't Repeat Yourself(DRY)

註解

用程式碼表達你的本意「寫註解的其中一個動機，是因為程式碼寫的太糟糕。」 - Uncle Bob 註解無法彌補糟糕的程式碼

在每個檔案的開頭都會寫入著作權聲名法律型註解有益的註解

沒辦法使用少量的單字為變數命名，或是用適當的動詞作為函式的命名對意圖的解釋有益的註解

docstring 有益的註解

喃喃自語糟糕的註解

干擾型註解糟糕的註解

交給Git 被註解的程式碼糟糕的註解

“The only way to go fast is to go well.“
- Uncle Bob

https://medium.com/%E6%89%8B%E5%AF%AB%E7%AD%86%E8%A8%98/clean-code-index- 51e209cc47db Reference

Thank you for listening

Clean Code

Clean Code

More Decks by Johnny Lin

Other Decks in Programming

Featured

Transcript