「代码写得好」是对机器学习研究者及开发者最好的赞扬。其第一层意思是说，你的模型非常好，有自己的理解与修正；第二层意思是说代码的结构、命名规则、编写逻辑都非常优秀。
我们曾经将写代码比喻成写文章：不仅需要有一个主旨，告诉别人代码的作用是什么，同时还应该在精炼与易读之间做权衡。代码过于精炼，整体逻辑难以跟随，代码过于易读，整体就显得比较臃肿。
在精简与易读之间做权衡，第一种方法根据列表推导式能获得更精简的代码，但第二种方法更易读。
如果说到什么是好代码，我们肯定都能说出一堆规则，例如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等。
但是对于什么是烂代码，你有比较清晰的认识吗？
在 GitHub 上有一个项目，它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格，下文没有进行转换。读者们可以以相反的角度来理解所有观点，这样就能完美避免写出垃圾代码。
项目地址：https://github.com/trekhleb/state-of-the-art-shitcode
当然，以下十九条垃圾代码书写准则并没有面面俱到，如果读者们发现有一些难以忍受的烂代码习惯，也可以后台留言发表你的看法。
第一条：打字越少越好
如果我们键入的东西越少，那么就有越多的时间去思考代码逻辑等问题。如下所示，「Good」表示遵循该规则的示例，Bad 表示没遵循该规则的示例。
第二条：变量/函数混合命名风格
我们需要混合命名方法与变量，这样才能体现命名的多样性。
第三条：不要写注释
反正代码都看得懂，为什么要写注释？或者说，反正没人看我的代码，为什么要写注释？
第四条：使用母语写注释
如果你违反了第三条规则，那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语，那么你也算违反了这条规则。既然编程语言绝大多数都是用英文，那么为什么不用其它语言注释一下？
第五条：尽可能混合不同的格式
同样，为了代码的多样性，我们需要尽可能混合不同的格式，例如单引号或双引号。如果它们的语义相同，那就应该混用。
第六条：尽可能把代码写成一行
如果一系列参数与方法都是一起实现的，那么代码也要写在一起。
第七条：发现错误要保持静默
当你发现某些错误时，其他人不需要了解它，因此不需要打印出日志或 Traceback。
第八条：广泛使用全局变量
使用全局变量，是面向「全球化」不可或缺的部分。
第九条：构建备用变量
以防万一，我们需要创建一些备用变量，在需要时随时调用它们。
第十条：Type 使用需谨慎
一般不要指定变量类型或者经常做类型检查，无类型才是最好的类型。
第十一条：准备「Plan B」
你需要准备一些运行不到的代码（unreachable code），它们可以作为你的「Plan B」。
第十二条：嵌套的三角法则
如果代码有一些嵌套结构，或者说缩进空行的结构，三角法则是最漂亮的。
第十三条：混合缩进
我们需要避免采用缩进，因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进，那么就使用混合缩进策略。当然，这种策略在 Python 中是行不通的，因为它靠缩进来确定代码结构。
第十四条：不要锁住依赖项
每一次要安装新库时，更新已有的依赖项。为什么要维持之前的版本呢，我们需要时刻保持最新的第三方代码库。
第十五条：长函数比短函数好
不要将程序整体逻辑分割为一些代码块，要是 IDE 突然不行了，它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中，并且不再维护额外的函数导入或代码文件，那么这样的方法是最稳定的。
单个文件一万行代码是没问题的，单个函数一千行代码也是没问题的。
第十六条：代码不需要做特定测试
这些测试通常是重复且无意义的工作。
第十七条：尽量避免重复代码
按你的想法写代码，尤其是在小团队中，毕竟这是「自由」准则。
第十八条：构建新项目不需要 README 文档
在项目前期，我们可以暂时保持这种状态。
第十九条：保存不必要的代码
在写代码的过程中，经常会产生很多测试代码。这些代码也是非常重要的资料，因此不能删除掉，最多只能注释掉。
1.编译C语言程序，使用 gcc 指令，而C++程序则推荐使用 g++指令！
2.2020年第9期《单片机与嵌入式系统应用》电子刊新鲜出炉！
免责声明：本文系网络转载，版权归原作者所有。如涉及作品版权问题，请与我们联系，我们将根据您提供的版权证明材料确认版权并支付稿酬或者删除内容。
扫一扫
5015
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
