乾淨程式碼的幾個特點 -Xebia

banq發表於2019-11-26

乾淨clean程式碼特點：易於他人使用（直截了當，意圖清晰，抽象性好，毫不意外，好名聲）-這是最受關注的問題。
  • 它是針對現實世界製作的，即具有清晰的錯誤處理策略。
  • 它是最小的（做一件事，具有最小的依賴性）。
  • 擅長做什麼。

清潔程式碼的屬性
  • 沒有重複
  • 做一件事
  • 有意義的名字
  • 微小的乾淨抽象
  • 富有表現力的
  • 單元測試
  • 顯而易見-（明顯的故事）
  • 簡單


為什麼重構和清理程式碼很重要？

  • 它使開發人員高效。
  • 這使新增新開發人員變得容易。
  • 易於擴充套件和長期維護。

作為初級開發人員，很容易爭辯說，一旦程式碼透過了編譯器，它們都是一樣的。對嗎？
該論點的缺陷在於它假定所有軟體開發人員都在編寫新程式碼。現實情況是，與編寫新程式碼相比，我們花費更多的時間閱讀和修改現有程式碼。
因此，程式碼的清潔度和可讀性對於專案成功至關重要。編寫清晰易讀的程式碼比選擇框架，測試覆蓋率或專案管理解決方案更為重要。

編寫乾淨程式碼的規則
命名：

  • 使用意圖（目的、動機）命名
  • 變數，函式或類的名稱應回答三個問題：a）為什麼存在？b）它是做什麼的？c）如何使用？
  • 方法名稱應該有意義。透過對方法的不良命名，可能會使您的程式碼難以理解。
  • 方法名稱應準確。

例如，一個Table類包含一個用於建立表的方法：

Table table = new Table();
table.create()
//適當

table.createTable() /*
錯誤，因為table.create足以描述它正用於建立表
*/

  • 避免使用虛假資訊。我們應避免使用含義與預期含義不同的詞
  • 呼叫介面
  • 不要呼叫實現

函式
一個寫得很好的主要函式應該讀起來像個故事。就像它執行的每個方法一樣，它應該做一件事，做得很好並且只能做：以正確的順序執行正確的方法。

註釋
註釋似乎是使程式碼更具可讀性的一種好方法，但是它們也很危險。為什麼是這樣？鮑伯叔叔最好的解釋是
因為他們說謊。並非總是如此，不是故意的，而是太頻繁了。註釋越舊，並且與描述的程式碼距離越遠，則很可能是純錯誤。原因很簡單。程式設計師無法現實地維護它們。”
經驗法則如下：
如果註釋描述了程式碼的用途，則它會有所幫助。如果註釋描述了程式碼的工作方式，那麼它將是有害的。
不要寫描述類代表什麼，解決了什麼問題的註釋等。不要寫註釋來解釋程式碼的控制流程。解釋程式碼“如何”工作的註釋表明您的程式碼不乾淨。
如果您需要解釋為什麼定義了變數或for迴圈在做什麼，請改寫一個命名函式。用您的程式碼記錄您的程式碼。

格式化
程式碼格式化是關於溝通的，溝通是專業開發人員的首要任務。
當同一專案中的不同程式碼塊看起來不同時，會使程式碼閱讀者懷疑這些差異是功能上的還是風格上的。這很不好，因為它增加了認知開銷。
 

相關文章