最怕同事写出这样的代码...(文末送书)
来源 | 机器之心
整理编辑:Jack-Cui
在 GitHub 上有一个项目,它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写,这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格,下文没有进行转换。读者们可以以相反的角度来理解所有观点,这样就能完美避免写出垃圾代码。
项目地址:
https://github.com/trekhleb/state-of-the-art-shitcode
当然,以下十九条垃圾代码书写准则并没有面面俱到,如果读者们发现有一些难以忍受的烂代码习惯,也可以发表你的看法。
💩 第一条:打字越少越好
如果我们键入的东西越少,那么就有越多的时间去思考代码逻辑等问题。如下所示,「Good」表示遵循该规则的示例,Bad 表示没遵循该规则的示例。
![](https://filescdn.proginn.com/be9f2d3eaff254d7aadc954f6da29882/99898ee7bfafa694dabcc5c46083237c.webp)
💩 第二条:变量/函数混合命名风格
我们需要混合命名方法与变量,这样才能体现命名的多样性。
![](https://filescdn.proginn.com/da91d5b5a8a13f9b22330f15624512b2/d24c9212a233974729ba0d2d75dde656.webp)
💩第三条:不要写注释
反正代码都看得懂,为什么要写注释?或者说,反正没人看我的代码,为什么要写注释?
![](https://filescdn.proginn.com/0a1e43eb2151268780ed145adb96b3a4/36db679736b94eed1fb67a7f730eebcb.webp)
💩第四条:使用母语写注释
如果你违反了第三条规则,那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语,那么你也算违反了这条规则。既然编程语言绝大多数都是用英文,那么为什么不用其它语言注释一下?
![](https://filescdn.proginn.com/a4395dd8817601e911c01895d2603a55/2e384337d3e7d9e1e7f289f9ceb5fcdc.webp)
💩第五条:尽可能混合不同的格式
同样,为了代码的多样性,我们需要尽可能混合不同的格式,例如单引号或双引号。如果它们的语义相同,那就应该混用。
![](https://filescdn.proginn.com/e39e030b1cb4d2bcec5e34b46177c5c9/2a10bd8e061481d94c415de9470711f5.webp)
💩第六条:尽可能把代码写成一行
如果一系列参数与方法都是一起实现的,那么代码也要写在一起。
![](https://filescdn.proginn.com/b6a32a3d24f2464e5cd334cbc5d14564/814c42194454f0c313c59ab2dae419ae.webp)
💩第七条:发现错误要保持静默
当你发现某些错误时,其他人不需要了解它,因此不需要打印出日志或 Traceback。
![](https://filescdn.proginn.com/060ce4adce18fb55744838d1f3ac598d/59ff1f8b67d30df45b7e8e3d47e25833.webp)
💩第八条:广泛使用全局变量
使用全局变量,是面向「全球化」不可或缺的部分。
![](https://filescdn.proginn.com/12f39509c689c2a21fac9c4fe7fa4d1a/36cfaad501bc14bc03301ba347d6d75f.webp)
💩第九条:构建备用变量
以防万一,我们需要创建一些备用变量,在需要时随时调用它们。
![](https://filescdn.proginn.com/cfbfddbef8066283cc663b11bb389824/50dc356ec044a36ab19e0b6d91d2ba22.webp)
💩第十条:Type 使用需谨慎
一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型。
![](https://filescdn.proginn.com/4c8d8037660484991fb06c8b828f3b3f/2b1f0c123ebcbbde303588c4ac2c1483.webp)
💩第十一条:准备「Plan B」
你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」。
![](https://filescdn.proginn.com/c70a365bcff249c5a7e382f851bb3c3a/38495d76fc0cffb0227340e47457e1cf.webp)
💩第十二条:嵌套的三角法则
如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的。
![](https://filescdn.proginn.com/f485eeca570fb45983e37b382cb44a76/cad21ef0b05a3366237fe166a70e3d64.webp)
💩第十三条:混合缩进
我们需要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进,那么就使用混合缩进策略。当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构。
![](https://filescdn.proginn.com/af7b9baa5532458eb52cffe1d96b5eca/039a8cfdf031f46e0b653464ebbf1777.webp)
💩第十四条:不要锁住依赖项
每一次要安装新库时,更新已有的依赖项。为什么要维持之前的版本呢,我们需要时刻保持最新的第三方代码库。
![](https://filescdn.proginn.com/2bbf4cb443d070d0b62a95d0274945d1/e32c972fc05e55873cc4c57385fd1462.webp)
💩第十五条:长函数比短函数好
不要将程序整体逻辑分割为一些代码块,要是 IDE 突然不行了,它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中,并且不再维护额外的函数导入或代码文件,那么这样的方法是最稳定的。
单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。
💩第十六条:代码不需要做特定测试
这些测试通常是重复且无意义的工作。
💩第十七条:尽量避免重复代码
按你的想法写代码,尤其是在小团队中,毕竟这是「自由」准则。
💩第十八条:构建新项目不需要 README 文档
在项目前期,我们可以暂时保持这种状态。
💩第十九条:保存不必要的代码
在写代码的过程中,经常会产生很多测试代码。这些代码也是非常重要的资料,因此不能删除掉,最多只能注释掉。
![](https://filescdn.proginn.com/11ba750fe39403dde4cecd702fd5d8d6/3c58fe3a59d38b4576c43403b9905a4f.webp)
![](https://filescdn.proginn.com/893ec0462346e9ef3c35c6ca64cd67ae/7b575274f6800fd2472beb0eba20b6d8.webp)
![](https://filescdn.proginn.com/ff1a574f7ad4750683adec6cde70942b/49b3294c51f695ea6bf92cc99a13b236.webp)
![](https://filescdn.proginn.com/b37cec5cd92e0043a0f071e510f21f88/b09fd65618c82f7f8a15154daed746ae.webp)
推荐理由:
过去网络安全距离我们很远,只要没有被攻击便可以忽略,而现在如果存在安全漏洞且一不小心被成功攻击,就可能导致很多公司财务等重要数据被勒索病毒感染,造成巨大经济损失!近几年来,国家展开了护网行动,加上各种机构经常组织CTF比赛等,网络安全越来越火,人才缺口也越来越大。“会渗透,是懂安全的基础;会漏扫,是懂渗透的基础;去实战,是检验能力的标准”此书可以给网络安全领域的专业人士或想入门的人士答疑解惑,是您必不可少的一本专业图书!
![](https://filescdn.proginn.com/ff1a574f7ad4750683adec6cde70942b/49b3294c51f695ea6bf92cc99a13b236.webp)
![](https://filescdn.proginn.com/b37cec5cd92e0043a0f071e510f21f88/b09fd65618c82f7f8a15154daed746ae.webp)
推荐理由:
“元宇宙”是重启新文明的的“元叙事”,是人类对乌托邦世界的思考和实践,技术、理想、 权力、资本与人性的较量将在元宇宙中展开,同时,元宇宙也会促进基础数学、信息学、生命科学、区块链、量子计算等学科的深入研究和交叉互动。
本书以简单易懂的文字,搭配轻松诙谐的原创漫画,让更多人理解什么是元宇宙的 “宏架构”,了解从原子到比特的逻辑,明白智能合约、数学及NFT之间的关系,用图片解析未来世界,让你轻松走进虚实共生的数字时空,解锁人类新文明,设计属于自己的元宇宙。
![](https://filescdn.proginn.com/ff1a574f7ad4750683adec6cde70942b/49b3294c51f695ea6bf92cc99a13b236.webp)
![](https://filescdn.proginn.com/b37cec5cd92e0043a0f071e510f21f88/b09fd65618c82f7f8a15154daed746ae.webp)
推荐理由:
算法是学习人工智能的基石,全书通过116个典型范例+86个AI经典算法+40道经典习题+42道面试真题+42个高手点拨+4套算法职位招聘真题+19个项目,用算法解析人工智能,并以Python为工具进行算法思想和解决方案的有效实践。
活动截止时我们将从本文的留言中选出5位幸运粉丝赠送书籍~
注意哦,每人每月仅限一本书籍~
活动截止时间:2022 年 7 月 4 日 16:00 整
兑奖截止时间:2022 年 7 月 5 日 16:00 整
![](https://filescdn.proginn.com/12cd493519e9b6d968ca8a53988f898e/cb6ac21628b89069c1e0e63b08fc80f4.webp)
![](https://filescdn.proginn.com/893ec0462346e9ef3c35c6ca64cd67ae/7b575274f6800fd2472beb0eba20b6d8.webp)