我們都經歷過這樣的情況——盯著應該可以工作但實際上不可讀的程式碼。讓我們面對現實:每個開發人員(是的,我們每個人)都曾在某個時候編寫過類似的程式碼。好訊息?重構是一項可以學習的技能,乾淨的程式碼也是觸手可及的。
因此,讓我們深入探討編寫乾淨程式碼的真正含義 - 不是抽象的、「只是使其整潔」類型的乾淨程式碼,而是可讀、可維護的類型,而且我敢說,幾乎是漂亮的。
1/ 真實地命名事物
乾淨的程式碼從清晰的命名開始。 不要亂寫無意義的 x
、 temp
或data
。您的變數和函數需要講述一個故事。
例子:
2/ 少即是多:函數大小的力量
你看過像小說一樣長的函數嗎?說實話-長函數是痛苦的。乾淨的程式碼在小型、單一用途的函數上蓬勃發展。將每個功能視為一個建置塊:它應該有一項工作,並且應該做得很好。
例子:
3/ 一致性是關鍵
想一想:如果您呼叫一個陣列userList
,請不要呼叫下一個users
。一致的命名、縮排和格式可以節省每個人的時間,因為它們建立了一種模式(一種節奏),使程式碼可預測。
例子:
4/ 有目的的評論,而不是出於習慣
評論很棒,但前提是它們能增加清晰度。如果你的程式碼很乾淨,那麼它需要的註解就會更少。對於您加入的內容,讓它們變得有價值。
例子:
5/ 魔法數字和硬編碼值 – 擺脫它們
如果你在任何地方都對值進行硬編碼,那麼以後就會遇到麻煩。相反,使用常量使這些數字有意義。
例子:
6/ DRY:不要重複自己
重複的程式碼對於維護來說是一場噩夢。找到一種方法來編寫可重複使用的函數或處理重複邏輯的模組,而不是複製貼上。
例子:
7/ 保持程式碼的完整性
SOLID 原則(單一職責、開閉式、里氏替換、介面隔離和依賴倒置)可能聽起來像是企業流行語,但它們對於編寫乾淨的程式碼非常實用。如果您對這些原則不熟悉,請從單一職責原則開始:每個類別或函數都應該有一項職責,並且是單獨的。
例子:
8/ 無情地重構
重構不只是一次性的事;而是一次的事。這是一種心態。每次檢查程式碼時,尋找可以改進的地方。重構就是要認識到程式碼很少在第一次就完美。不要害怕不斷地改變東西,直到它們真正乾淨為止。
例子:
如果您能掌握這些基礎知識,那麼您就已經遙遙領先。
原文出處:https://dev.to/balrajola/how-to-write-clean-code-refactoring-and-best-practices-1mo