手牵手教你写代码，从入门到精通
如果说到什么是好代码，我们肯定都能说出一堆规则，例如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等。
但是对于什么是烂代码，你有比较清晰的认识吗？
在 GitHub 上有一个新项目，它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格，下文没有进行转换。读者们可以以相反的角度来理解所有观点，这样就能完美避免写出垃圾代码。
repo 地址： https://github.com/trekhleb/state-of-the-art-shitcode
当然，以下十九条垃圾代码书写准则并没有面面俱到，如果读者们发现有一些难以忍受的烂代码习惯，也可以留言发表你的看法。
第一条：打字越少越好
如果我们键入的东西越少，那么就有越多的时间去思考代码逻辑等问题。如下所示，「Good」表示遵循该规则的示例，Bad 表示没遵循该规则的示例。
手牵手教你写代码，从入门到精通
第二条：****变量/函数混合命名风格我们需要混合命名方法与变量，这样才能体现命名的多样性。
手牵手教你写代码，从入门到精通
第三条：****不要写注释反正代码都看得懂，为什么要写注释？或者说，反正没人看我的代码，为什么要写注释？
手牵手教你写代码，从入门到精通
第四条：****使用母语写注释如果你违反了第三条规则，那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语，那么你也算违反了这条规则。既然编程语言绝大多数都是用英文，那么为什么不用其它语言注释一下？
手牵手教你写代码，从入门到精通
第五条：****尽可能混合不同的格式同样，为了代码的多样性，我们需要尽可能混合不同的格式，例如单引号或双引号。如果它们的语义相同，那就应该混用。
手牵手教你写代码，从入门到精通
第六条：****尽可能把代码写成一行如果一系列参数与方法都是一起实现的，那么代码也要写在一起。
手牵手教你写代码，从入门到精通
第七条：****发现错误要保持静默当你发现某些错误时，其他人不需要了解它，因此不需要打印出日志或 Traceback。
手牵手教你写代码，从入门到精通
第八条：****广泛使用全局变量使用全局变量，是面向「全球化」不可或缺的部分。
手牵手教你写代码，从入门到精通
第九条：****构建备用变量以防万一，我们需要创建一些备用变量，在需要时随时调用它们。
手牵手教你写代码，从入门到精通
第十条：****Type 使用需谨慎一般不要指定变量类型或者经常做类型检查，无类型才是最好的类型。
手牵手教你写代码，从入门到精通
第十一条：****准备「Plan B」你需要准备一些运行不到的代码（unreachable code），它们可以作为你的「Plan B」。
手牵手教你写代码，从入门到精通
第十二条：****嵌套的三角法则如果代码有一些嵌套结构，或者说缩进空行的结构，三角法则是最漂亮的。
手牵手教你写代码，从入门到精通
第十三条：****混合缩进我们需要避免采用缩进，因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进，那么就使用混合缩进策略。当然，这种策略在 Python 中是行不通的，因为它靠缩进来确定代码结构。
手牵手教你写代码，从入门到精通
第十四条：****不要锁住依赖项每一次要安装新库时，更新已有的依赖项。为什么要维持之前的版本呢，我们需要时刻保持最新的第三方代码库。
手牵手教你写代码，从入门到精通
第十五条：****长函数比短函数好不要将程序整体逻辑分割为一些代码块，要是 IDE 突然不行了，它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中，并且不再维护额外的函数导入或代码文件，那么这样的方法是最稳定的。单个文件一万行代码是没问题的，单个函数一千行代码也是没问题的。
第十六条：****代码不需要做特定测试这些测试通常是重复且无意义的工作。
第十七条：****尽量避免重复代码按你的想法写代码，尤其是在小团队中，毕竟这是「自由」准则。
第十八条：****构建新项目不需要 README 文档在项目前期，我们可以暂时保持这种状态。
第十九条：****保存不必要的代码在写代码的过程中，经常会产生很多测试代码。这些代码也是非常重要的资料，因此不能删除掉，最多只能注释掉。
手牵手教你写代码，从入门到精通相关推荐
- 手牵手教你写 Vue 插件
碎碎念 上一篇文章,我们介绍了如何构建一个 react 插件,今天我们说说如何构建 vue 插件 准备工作 由于与上一篇 react 插件文章使用的是相同的结构,代码测试.持续集成及发布 npm 包也 ...
- 教机器写代码：增强拓扑进化网络(NEAT)
教机器写代码:增强拓扑进化网络(NEAT) 在这篇文章中,我将向大家介绍一种名为增强拓扑进化网络(NEAT)的机器学习方法. 介绍 我喜欢学习.每当遇到从未接触过的书籍或论文,并开始阅读的时候,我都会 ...
- 猛男教你写代码_猛男程序员，鼓存储器和1960年代机器代码的取证分析
猛男教你写代码 真正的程序员不使用PASCAL (Real programmers don't use PASCAL) Programmers today build distributed appl ...
- 从教女友写代码中学到的，教人写代码在一定程度上是硬件问题
从今年四月一直到七月,我在教我女友写代码.我最大的收获是认识到了教人写代码在一定程度上是个硬件问题.虽然 codecademy.可 汗学 院.Scratch 和其他机构为了教学优化了代码编辑器,但代码 ...
- paddlepaddle系列之三行代码从入门到精通
PaddlePaddle系列之三行代码从入门到精通 前言 这将是PaddlePaddle系列教程的开篇,属于非官方教程.既然是非官方,自然会从一个使用者的角度出发,来教大家怎么用,会有哪些坑,以及如何 ...
- 用Python和Pygame写游戏-从入门到精通（1）
From: http://eyehere.net/2011/python-pygame-novice-professional-1/ 博客刚开,打算做一个Pygame的系列,翻译自Will McGug ...
- PaddlePaddle 系列之三行代码从入门到精通
本文介绍 PaddlePaddle 系列之三行代码从入门到精通. 前言 这将是 PaddlePaddle 系列教程的开篇,属于非官方教程.既然是非官方,自然会从一个使用者的角度出发,来教大家怎么用,会 ...
- python教程是用什么博客写的-用Python和Pygame写游戏-从入门到精通（目录）
目光博客一开始,就有一个将pygame好好介绍一遍的宏伟计划,历时四个月,在各位朋友的关怀鞭策下,如今(2011/8/26)理论学习的部分似乎已经都完成了,在次列一个目录,方便查询.介绍还不是很全,下 ...
- python游戏开发框架_用Python和Pygame写游戏-从入门到精通（实战二：恶搞俄罗斯方块1）...
游戏是为了什么而存在的?Bingo,是为了娱乐~ 在这个最高主题之前,技术啥的什么都无所谓! 前一段时间,有位姓刘的网友用Pygame写了个俄罗斯方块,在用py2exe打包的时候遇到一些问题,和我交流 ...
最新文章
- 硬件工程师必备秘籍，模拟电子经典200问！
- mysql连接查询拒绝服务漏洞_MySQL-连接查询
- python 共现矩阵_Python词组共现矩阵
- 深圳python指南_深圳Pythonlevel7
- iOS coredata 避免添加重复数据
- Java中replace、replaceAll和replaceFirst函数的用法小结
- 详解 Qt 串口通信程序全程图文 （5）
- 推荐系统基础之介绍入门篇
- android 电容屏（一）：电容屏基本原理篇
- 盛金公式解一元三次方程_一元三次方程的解法
- xp服务器文件写保护怎么删除,winxp系统复制文件提示“请去掉写保护或使用另一张磁盘”的解决...
- 新手搭建网站后视频资源在网站上是如何存储的？
- 赛迪网：VMware访谈实录
- Java读取txt格式文件打印到控制台
- u盘安装计算机系统,U盘系统_详细教您将系统安装到U盘
- 磁力小伙伴，配合使用效果极佳！
- Envato不停机迁移边缘网络提供商
- LDAP 协议有哪些现代化的用例？
- 基于c++和asio的网络编程框架asio2教程基础篇：2、各个回调函数的触发顺序和执行流程
- 电脑显示器如何实现分屏 一台主机两台显示器分屏