最怕同事寫出這樣的代碼...（文末送書）
來源 | 機(jī)器之心
整理編輯：Jack-Cui
在 GitHub 上有一個(gè)項(xiàng)目，它描述了「最佳垃圾代碼」的十九條關(guān)鍵準(zhǔn)則。從變量命名到注釋編寫，這些準(zhǔn)則將指導(dǎo)你寫出最亮眼的爛代碼。
為了保持與原 GitHub 項(xiàng)目一致的風(fēng)格，下文沒有進(jìn)行轉(zhuǎn)換。讀者們可以以相反的角度來理解所有觀點(diǎn)，這樣就能完美避免寫出垃圾代碼。
項(xiàng)目地址：
https://github.com/trekhleb/state-of-the-art-shitcode
當(dāng)然，以下十九條垃圾代碼書寫準(zhǔn)則并沒有面面俱到，如果讀者們發(fā)現(xiàn)有一些難以忍受的爛代碼習(xí)慣，也可以發(fā)表你的看法。
?? 第一條：打字越少越好
如果我們鍵入的東西越少，那么就有越多的時(shí)間去思考代碼邏輯等問題。如下所示，「Good」表示遵循該規(guī)則的示例，Bad 表示沒遵循該規(guī)則的示例。
?? 第二條：變量/函數(shù)混合命名風(fēng)格
我們需要混合命名方法與變量，這樣才能體現(xiàn)命名的多樣性。
??第三條：不要寫注釋
反正代碼都看得懂，為什么要寫注釋？或者說，反正沒人看我的代碼，為什么要寫注釋？
??第四條：使用母語寫注釋
如果你違反了第三條規(guī)則，那么至少寫注釋需要用你的母語或者其它語言。如果你的母語是英語，那么你也算違反了這條規(guī)則。既然編程語言絕大多數(shù)都是用英文，那么為什么不用其它語言注釋一下？
??第五條：盡可能混合不同的格式
同樣，為了代碼的多樣性，我們需要盡可能混合不同的格式，例如單引號或雙引號。如果它們的語義相同，那就應(yīng)該混用。
??第六條：盡可能把代碼寫成一行
如果一系列參數(shù)與方法都是一起實(shí)現(xiàn)的，那么代碼也要寫在一起。
??第七條：發(fā)現(xiàn)錯(cuò)誤要保持靜默
當(dāng)你發(fā)現(xiàn)某些錯(cuò)誤時(shí)，其他人不需要了解它，因此不需要打印出日志或 Traceback。
??第八條：廣泛使用全局變量
使用全局變量，是面向「全球化」不可或缺的部分。
??第九條：構(gòu)建備用變量
以防萬一，我們需要?jiǎng)?chuàng)建一些備用變量，在需要時(shí)隨時(shí)調(diào)用它們。
??第十條：Type 使用需謹(jǐn)慎
一般不要指定變量類型或者經(jīng)常做類型檢查，無類型才是最好的類型。
??第十一條：準(zhǔn)備「Plan B」
你需要準(zhǔn)備一些運(yùn)行不到的代碼（unreachable code），它們可以作為你的「Plan B」。
??第十二條：嵌套的三角法則
如果代碼有一些嵌套結(jié)構(gòu)，或者說縮進(jìn)空行的結(jié)構(gòu)，三角法則是最漂亮的。
??第十三條：混合縮進(jìn)
我們需要避免采用縮進(jìn)，因?yàn)榭s進(jìn)會使復(fù)雜代碼在編輯器中占用更多的空間。如果一定要采用縮進(jìn)，那么就使用混合縮進(jìn)策略。當(dāng)然，這種策略在 Python 中是行不通的，因?yàn)樗靠s進(jìn)來確定代碼結(jié)構(gòu)。
??第十四條：不要鎖住依賴項(xiàng)
每一次要安裝新庫時(shí)，更新已有的依賴項(xiàng)。為什么要維持之前的版本呢，我們需要時(shí)刻保持最新的第三方代碼庫。
??第十五條：長函數(shù)比短函數(shù)好
不要將程序整體邏輯分割為一些代碼塊，要是 IDE 突然不行了，它找不到必要的文件或函數(shù)怎么辦。因此把代碼寫在一個(gè)主體函數(shù)中，并且不再維護(hù)額外的函數(shù)導(dǎo)入或代碼文件，那么這樣的方法是最穩(wěn)定的。
單個(gè)文件一萬行代碼是沒問題的，單個(gè)函數(shù)一千行代碼也是沒問題的。
??第十六條：代碼不需要做特定測試
這些測試通常是重復(fù)且無意義的工作。
??第十七條：盡量避免重復(fù)代碼
按你的想法寫代碼，尤其是在小團(tuán)隊(duì)中，畢竟這是「自由」準(zhǔn)則。
??第十八條：構(gòu)建新項(xiàng)目不需要 README 文檔
在項(xiàng)目前期，我們可以暫時(shí)保持這種狀態(tài)。
??第十九條：保存不必要的代碼
在寫代碼的過程中，經(jīng)常會產(chǎn)生很多測試代碼。這些代碼也是非常重要的資料，因此不能刪除掉，最多只能注釋掉。
推薦理由：
過去網(wǎng)絡(luò)安全距離我們很遠(yuǎn)，只要沒有被攻擊便可以忽略，而現(xiàn)在如果存在安全漏洞且一不小心被成功攻擊，就可能導(dǎo)致很多公司財(cái)務(wù)等重要數(shù)據(jù)被勒索病毒感染，造成巨大經(jīng)濟(jì)損失！近幾年來，國家展開了護(hù)網(wǎng)行動，加上各種機(jī)構(gòu)經(jīng)常組織CTF比賽等，網(wǎng)絡(luò)安全越來越火，人才缺口也越來越大。“會滲透，是懂安全的基礎(chǔ)；會漏掃，是懂滲透的基礎(chǔ)；去實(shí)戰(zhàn)，是檢驗(yàn)?zāi)芰Φ臉?biāo)準(zhǔn)”此書可以給網(wǎng)絡(luò)安全領(lǐng)域的專業(yè)人士或想入門的人士答疑解惑，是您必不可少的一本專業(yè)圖書!
推薦理由：
“元宇宙”是重啟新文明的的“元敘事”，是人類對烏托邦世界的思考和實(shí)踐，技術(shù)、理想、 權(quán)力、資本與人性的較量將在元宇宙中展開，同時(shí)，元宇宙也會促進(jìn)基礎(chǔ)數(shù)學(xué)、信息學(xué)、生命科學(xué)、區(qū)塊鏈、量子計(jì)算等學(xué)科的深入研究和交叉互動。
本書以簡單易懂的文字，搭配輕松詼諧的原創(chuàng)漫畫，讓更多人理解什么是元宇宙的 “宏架構(gòu)”，了解從原子到比特的邏輯，明白智能合約、數(shù)學(xué)及NFT之間的關(guān)系，用圖片解析未來世界，讓你輕松走進(jìn)虛實(shí)共生的數(shù)字時(shí)空，解鎖人類新文明，設(shè)計(jì)屬于自己的元宇宙。
推薦理由：
算法是學(xué)習(xí)人工智能的基石，全書通過116個(gè)典型范例+86個(gè)AI經(jīng)典算法+40道經(jīng)典習(xí)題+42道面試真題+42個(gè)高手點(diǎn)撥+4套算法職位招聘真題+19個(gè)項(xiàng)目，用算法解析人工智能，并以Python為工具進(jìn)行算法思想和解決方案的有效實(shí)踐。
活動截止時(shí)我們將從本文的留言中選出5位幸運(yùn)粉絲贈送書籍~
注意哦，每人每月僅限一本書籍~
活動截止時(shí)間：2022 年 7 月 4 日 16：00 整
兌獎(jiǎng)截止時(shí)間：2022 年 7 月 5 日 16：00 整
