大家好，我是你們可愛的喵哥！
如果說到什麼是好代碼，我們肯定都能說出一堆規則，例如使用一致的格式和縮進、使用清晰的變量名和方法名、在必要時提供文檔與註釋、不要過度精簡代碼等等。
但是對於什麼是爛代碼，你有比較清晰的認識嗎？
在 GitHub 上有一個新項目，它描述了「最佳垃圾代碼」的十九條關鍵準則。從變量命名到註釋編寫。這些準則將指導你寫出最亮眼的爛代碼。
爲了保持與原 GitHub 項目一致的風格，下文沒有進行轉換。讀者們可以以相反的角度來理解所有觀點，這樣就能完美避免寫出垃圾代碼。
項目地址：https://github.com/trekhleb/state-of-the-art-shitcode
當然，以下十九條垃圾代碼書寫準則並沒有面面俱到，如果讀者們發現有一些難以忍受的爛代碼習慣，也可以留言發表你的看法。
第一條：打字越少越好
如果我們鍵入的東西越少，那麼就有越多的時間去思考代碼邏輯等問題。如下所示，「Good」表示遵循該規則的示例，Bad 表示沒遵循該規則的示例。
img
第二條：變量/函數混合命名風格
我們需要混合命名方法與變量，這樣才能體現命名的多樣性。
img
第三條：不要寫註釋
反正代碼都看得懂，爲什麼要寫註釋？或者說，反正沒人看我的代碼，爲什麼要寫註釋？
img
第四條：使用母語寫註釋
如果你違反了第三條規則，那麼至少寫註釋需要用你的母語或者其它語言。如果你的母語是英語，那麼你也算違反了這條規則。既然編程語言絕大多數都是用英文，那麼爲什麼不用其它語言註釋一下？
img
第五條：儘可能混合不同的格式
同樣，爲了代碼的多樣性，我們需要儘可能混合不同的格式，例如單引號或雙引號。如果它們的語義相同，那就應該混用。
img
第六條：儘可能把代碼寫成一行
如果一系列參數與方法都是一起實現的，那麼代碼也要寫在一起。
img
第七條：發現錯誤要保持靜默
當你發現某些錯誤時，其他人不需要了解它，因此不需要打印出日誌或 Traceback。
img
第八條：廣泛使用全局變量
使用全局變量，是面向「全球化」不可或缺的部分。
img
第九條：構建備用變量
以防萬一，我們需要創建一些備用變量，在需要時隨時調用它們。
img
第十條：Type 使用需謹慎
一般不要指定變量類型或者經常做類型檢查，無類型纔是最好的類型。
img
第十一條：準備「Plan B」
你需要準備一些運行不到的代碼（unreachable code），它們可以作爲你的「Plan B」。
img
第十二條：嵌套的三角法則
如果代碼有一些嵌套結構，或者說縮進空行的結構，三角法則是最漂亮的。
img
第十三條：混合縮進
我們需要避免採用縮進，因爲縮進會使複雜代碼在編輯器中佔用更多的空間。如果一定要採用縮進，那麼就使用混合縮進策略。當然，這種策略在 Python 中是行不通的，因爲它靠縮進來確定代碼結構。
img
第十四條：不要鎖住依賴項
每一次要安裝新庫時，更新已有的依賴項。爲什麼要維持之前的版本呢，我們需要時刻保持最新的第三方代碼庫。
img
第十五條：長函數比短函數好
不要將程序整體邏輯分割爲一些代碼塊，要是 IDE 突然不行了，它找不到必要的文件或函數怎麼辦。因此把代碼寫在一個主體函數中，並且不再維護額外的函數導入或代碼文件，那麼這樣的方法是最穩定的。
單個文件一萬行代碼是沒問題的，單個函數一千行代碼也是沒問題的。
第十六條：代碼不需要做特定測試
這些測試通常是重複且無意義的工作。
第十七條：儘量避免重複代碼
按你的想法寫代碼，尤其是在小團隊中，畢竟這是「自由」準則。
第十八條：構建新項目不需要 README 文檔
在項目前期，我們可以暫時保持這種狀態。
第十九條：保存不必要的代碼
在寫代碼的過程中，經常會產生很多測試代碼。這些代碼也是非常重要的資料，因此不能刪除掉，最多隻能註釋掉。
1.GD32 Arm MCU物聯網開發者線上課程精彩內容預告！
2.楊福宇專欄|尋找可超車的彎道：偉人講破字當頭，立也在其中了
免責聲明：本文系網絡轉載，版權歸原作者所有。如涉及作品版權問題，請與我們聯繫，我們將根據您提供的版權證明材料確認版權並支付稿酬或者刪除內容。