如何写出让同事好维护的代码？
寫出整潔的代碼，是每個程序員的追求。《clean code》指出，要想寫出好的代碼，首先得知道什么是骯臟代碼、什么是整潔代碼；然后通過大量的刻意練習，才能真正寫出整潔的代碼。
WTF/min是衡量代碼質量的唯一標準，Uncle Bob在書中稱糟糕的代碼為沼澤（wading），這只突出了我們是糟糕代碼的受害者。國內有一個更適合的詞匯：屎山，雖然不是很文雅但是更加客觀，程序員既是受害者也是加害者。
對于什么是整潔的代碼，書中給出了大師們的總結：
其中，我最喜歡的是表達力（Expressiveness）這個描述，這個詞似乎道出了好代碼的真諦：用簡單直接的方式描繪出代碼的功能，不多也不少。
命名的藝術
坦白的說，命名是一件困難的事情，要想出一個恰到好處的命名需要一番功夫，尤其我們的母語還不是編程語言所通用的英語。不過這一切都是值得了，好的命名讓你的代碼更直觀，更有表達力。
好的命名應該有下面的特征：
名副其實
好的變量名告訴你：是什么東西，為什么存在，該怎么使用
如果需要通過注釋來解釋變量，那么就先得不那么名副其實了。
避免誤導
不要掛羊頭賣狗肉
不要覆蓋慣用縮略語
這里不得不吐槽前兩天才看到的一份代碼，居然使用了 l 作為變量名；而且，user居然是一個list（單復數都沒學好！！）
有意義的區分
代碼是寫給機器執行，也是給人閱讀的，所以概念一定要有區分度。
如果名稱讀不出來，那么討論的時候就會像個傻鳥
名字長短應與其作用域大小相對應
比如在代碼中寫一個temp，那么讀者就得每次看到這個單詞的時候翻譯成其真正的意義
注釋
有表達力的代碼是無需注釋的。
The proper use of comments is to compensate for our failure to express ourself in code.
注釋的適當作用在于彌補我們用代碼表達意圖時遇到的失敗，這聽起來讓人沮喪，但事實確實如此。The truth is in the code, 注釋只是二手信息，二者的不同步或者不等價是注釋的最大問題。
書中給出了一個非常形象的例子來展示：用代碼來闡述，而非注釋
bad // check to see if the employee is eligible for full benefit if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))good if (employee.isEligibleForFullBenefits())因此，當想要添加注釋的時候，可以想想是否可以通過修改命名，或者修改函數（代碼）的抽象層級來展示代碼的意圖。
當然，也不能因噎廢食，書中指出了以下一些情況屬于好的注釋
其中個人最贊同的是第2點和第5點，做什么很容易通過命名表達，但為什么要這么做則并不直觀，特別涉及到專業知識、算法的時候。
另外，有些第一感覺“不那么優雅”的代碼，也許有其特殊愿意，那么這樣的代碼就應該加上注釋，說明為什么要這樣，比如為了提升關鍵路徑的性能，可能會犧牲部分代碼的可讀性。7點建議助您寫出優雅的Java代碼！這篇也可以看下。
最壞的注釋就是過時或者錯誤的注釋，這對于代碼的維護者（也許就是幾個月后的自己）是巨大的傷害，可惜除了code review，并沒有簡單易行的方法來保證代碼與注釋的同步。
函數
函數的單一職責
一個函數應該只做一件事，這件事應該能通過函數名就能清晰的展示。判斷方法很簡單：看看函數是否還能再拆出一個函數。
函數要么做什么do_sth, 要么查詢什么query_sth。最惡心的就是函數名表示只會query_sth, 但事實上卻會do_sth, 這使得函數產生了副作用。比如書中的例子
public class UserValidator {private Cryptographer cryptographer;public boolean checkPassword(String userName, String password) {User user = UserGateway.findByName(userName);if (user != User.NULL) {String codedPhrase = user.getPhraseEncodedByPassword();String phrase = cryptographer.decrypt(codedPhrase, password);if ("Valid Password".equals(phrase)) {Session.initialize();return true;}}return false;} }函數的抽象層級
每個函數一個抽象層次，函數中的語句都要在同一個抽象層級，不同的抽象層級不能放在一起。比如我們想把大象放進冰箱，應該是這個樣子的：
def pushElephantIntoRefrige():openRefrige()pushElephant()closeRefrige()函數里面的三句代碼在同一個層級（高度）描述了要完成把大象放進冰箱這件事順序相關的三個步驟。顯然，pushElephant這個步驟又可能包含很多子步驟，但是在pushElephantIntoRefrige這個層級，是無需知道太多細節的。
當我們想通過閱讀代碼的方式來了解一個新的項目時，一般都是采取廣度優先的策略，自上而下的閱讀代碼，先了解整體結構，然后再深入感興趣的細節。
如果沒有對實現細節進行良好的抽象（并凝練出一個名副其實的函數），那么閱讀者就容易迷失在細節的汪洋里。
某種程度看來，這個跟金字塔原理也很像
每一個層級都是為了論證其上一層級的觀點，同時也需要下一層級的支持；同一層級之間的多個論點又需要以某種邏輯關系排序。
pushElephantIntoRefrige就是中心論點，需要多個子步驟的支持，同時這些子步驟之間也有邏輯先后順序。
函數參數
函數的參數越多，組合出的輸入情況就愈多，需要的測試用例也就越多，也就越容易出問題。
輸出參數相比返回值難以理解，這點深有同感，輸出參數實在是很不直觀。從函數調用者的角度，一眼就能看出返回值，而很難識別輸出參數。輸出參數通常逼迫調用者去檢查函數簽名，這個實在不友好。
向函數傳入Boolean（書中稱之為 Flag Argument）通常不是好主意。尤其是傳入True or False后的行為并不是一件事情的兩面，而是兩件不同的事情時。這很明顯違背了函數的單一職責約束，解決辦法很簡單，那就是用兩個函數。
Dont repear yourself
在函數這個層級，是最容易、最直觀實現復用的，很多IDE也難幫助我們講一段代碼重構出一個函數。
不過在實踐中，也會出現這樣一種情況：一段代碼在多個方法中都有使用，但是又不完全一樣，如果抽象成一個通用函數，那么就需要加參數、加if else區別。這樣就有點尷尬，貌似可以重構，但又不是很完美。
造成上述問題的某種情況是因為，這段代碼也違背了單一職責原則，做了不只一件事情，這才導致不好復用，解決辦法是進行方法的細分，才能更好復用。也可以考慮template method來處理差異的部分。
測試
非常慚愧的是，在我經歷的項目中，測試（尤其是單元測試）一直都沒有得到足夠的重視，也沒有試行過TDD。正因為缺失，才更感良好測試的珍貴。
我們常說，好的代碼需要有可讀性、可維護性、可擴展性，好的代碼、架構需要不停的重構、迭代，但自動化測試是保證這一切的基礎，沒有高覆蓋率的、自動化的單元測試、回歸測試，誰都不敢去修改代碼，只能任其腐爛。
即使針對核心模塊寫了單元測試，一般也很隨意，認為這只是測試代碼，配不上生產代碼的地位，以為只要能跑通就行了。這就導致測試代碼的可讀性、可維護性非常差，然后導致測試代碼很難跟隨生產代碼一起更新、演化，最后導致測試代碼失效。所以說，臟測試 - 等同于 - 沒測試。
因此，測試代碼的三要素：可讀性，可讀性，可讀性。
對于測試的原則、準則如下：
測試的FIRST準則：
本文作者：xybaby
本文來源：“掘金”
原文鏈接：https://developer.aliyun.com/article/769733?
版權聲明：本文內容由阿里云實名注冊用戶自發貢獻，版權歸原作者所有，阿里云開發者社區不擁有其著作權，亦不承擔相應法律責任。具體規則請查看《阿里云開發者社區用戶服務協議》和《阿里云開發者社區知識產權保護指引》。如果您發現本社區中有涉嫌抄襲的內容，填寫侵權投訴表單進行舉報，一經查實，本社區將立刻刪除涉嫌侵權內容。總結
以上是生活随笔為你收集整理的如何写出让同事好维护的代码？的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 闲鱼商品理解和选品，究竟是怎么做的？
- 下一篇： 2020年8月编程语言排行榜新鲜出炉 -