本文經機器之心（微信公眾號：almosthuman2014）授權轉載，禁止二次轉載，參與：思
要是想寫個爛代碼，我們只需遵守這十九條準則？
「代碼寫得好」是對機器學習研究者及開發者最好的贊揚，其第一層意思是說，你的模型非常好，有自己的理解與修正；第二層意思是說代碼的結構、命名規則、撰寫邏輯都非常優秀，
我們曾經將寫代碼比喻成寫文章：不僅需要有一個主旨，告訴別人代碼的作用是什么，同時還應該在精煉與易讀之間做權衡，代碼過于精煉，整體邏輯難以跟隨，代碼過于易讀，整體就顯得比較臃腫，
在精簡與易讀之間做權衡，第一種方法根據串列推導式能獲得更精簡的代碼，但第二種方法更易讀，
如果說到什么是好代碼，我們肯定都能說出一堆規則，例如使用一致的格式和縮進、使用清晰的變數名和方法名、在必要時提供檔案與注釋、不要過度精簡代碼等等，
但是對于什么是爛代碼，你有比較清晰的認識嗎？
在 GitHub 上有一個新專案，它描述了「最佳垃圾代碼」的十九條關鍵準則，從變數命名到注釋撰寫，這些準則將指導你寫出最亮眼的爛代碼，
為了保持與原 GitHub 專案一致的風格，下文沒有進行轉換，讀者們可以以相反的角度來理解所有觀點，這樣就能完美避免寫出垃圾代碼，
專案地址：https://github.com/trekhleb/state-of-the-art-shitcode
當然，以下十九條垃圾代碼書寫準則并沒有面面俱到，如果讀者們發現有一些難以忍受的爛代碼習慣，也可以留言發表你的看法，
第一條：****打字越少越好
如果我們鍵入的東西越少，那么就有越多的時間去思考代碼邏輯等問題，如下所示，「Good」表示遵循該規則的示例，Bad 表示沒遵循該規則的示例，
第二條：變數/函式混合命名風格
我們需要混合命名方法與變數，這樣才能體現命名的多樣性，
第三條：不要寫注釋
反正代碼都看得懂，為什么要寫注釋？或者說，反正沒人看我的代碼，為什么要寫注釋？
第四條：使用母語寫注釋
如果你違反了第三條規則，那么至少寫注釋需要用你的母語或者其它語言，如果你的母語是英語，那么你也算違反了這條規則，既然編程語言絕大多數都是用英文，那么為什么不用其它語言注釋一下？
這篇《如何寫出讓同事好維護的代碼？》也牛逼，
第五條：盡可能混合不同的格式
同樣，為了代碼的多樣性，我們需要盡可能混合不同的格式，例如單引號或雙引號，如果它們的語意相同，那就應該混用，
第六條：盡可能把代碼寫成一行
如果一系列引數與方法都是一起實作的，那么代碼也要寫在一起，
第七條：發現錯誤要保持靜默
當你發現某些錯誤時，其他人不需要了解它，因此不需要列印出日志或 Traceback，
第八條：廣泛使用全域變數
使用全域變數，是面向「全球化」不可或缺的部分，《寫了個全域變數的bug，被同事們打臉！》這篇推薦看下，關注公眾號Java技術堆疊獲取我分享的更多好玩的干貨，
第九條：構建備用變數
以防萬一，我們需要創建一些備用變數，在需要時隨時呼叫它們，
第十條：Type 使用需謹慎
一般不要指定變數型別或者經常做型別檢查，無型別才是最好的型別，
第十一條：準備「Plan B」
你需要準備一些運行不到的代碼（unreachable code），它們可以作為你的「Plan B」，
第十二條：嵌套的三角法則
如果代碼有一些嵌套結構，或者說縮進空行的結構，三角法則是最漂亮的，
第十三條：混合縮進
我們需要避免采用縮進，因為縮進會使復雜代碼在編輯器中占用更多的空間，如果一定要采用縮進，那么就使用混合縮進策略，當然，這種策略在 Python 中是行不通的，因為它靠縮進來確定代碼結構，
第十四條：不要鎖住依賴項
每一次要安裝新庫時，更新已有的依賴項，為什么要維持之前的版本呢，我們需要時刻保持最新的第三方代碼庫，
第十五條：長函式比短函式好
不要將程式整體邏輯分割為一些代碼塊，要是 IDE 突然不行了，它找不到必要的檔案或函式怎么辦，因此把代碼寫在一個主體函式中，并且不再維護額外的函式匯入或代碼檔案，那么這樣的方法是最穩定的，
單個檔案一萬行代碼是沒問題的，單個函式一千行代碼也是沒問題的，
第十六條：代碼不需要做特定測驗
這些測驗通常是重復且無意義的作業，
第十七條：盡量避免重復代碼
按你的想法寫代碼，尤其是在小團隊中，畢竟這是「自由」準則，
第十八條：構建新專案不需要 README 檔案
在專案前期，我們可以暫時保持這種狀態，
第十九條：保存不必要的代碼
在寫代碼的程序中，經常會產生很多測驗代碼，這些代碼也是非常重要的資料，因此不能洗掉掉，最多只能注釋掉，
推薦去我的博客閱讀更多：
1.Java JVM、集合、多執行緒、新特性系列教程
2.Spring MVC、Spring Boot、Spring Cloud 系列教程
3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程
4.Java、后端、架構、阿里巴巴等大廠最新面試題
覺得不錯，別忘了點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/3002.html
標籤：Java
上一篇：Java中你所不知道的null