要是想写个烂代码，咱们只需遵照这十九条准则？
「代码写得好」是对机器学习研究者及开发者最好的赞赏。其第一层意思是说，你的模型很是好，有本身的理解与修正；第二层意思是说代码的结构、命名规则、编写逻辑都很是优秀。git
咱们曾经将写代码比喻成写文章：不只须要有一个主旨，告诉别人代码的做用是什么，同时还应该在精炼与易读之间作权衡。代码过于精炼，总体逻辑难以跟随，代码过于易读，总体就显得比较臃肿。github
在精简与易读之间作权衡，第一种方法根据列表推导式能得到更精简的代码，但第二种方法更易读。web
若是说到什么是好代码，咱们确定都能说出一堆规则，例如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过分精简代码等等。编程
可是对于什么是烂代码，你有比较清晰的认识吗？微信
在 GitHub 上有一个新项目，它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。机器学习
为了保持与原 GitHub 项目一致的风格，下文没有进行转换。读者们能够以相反的角度来理解全部观点，这样就能完美避免写出垃圾代码。编程语言
项目地址：https://github.com/trekhleb/state-of-the-art-shitcode编辑器
固然，如下十九条垃圾代码书写准则并无面面俱到，若是读者们发现有一些难以忍受的烂代码习惯，也能够留言发表你的见解。函数
第一条：打字越少越好学习
若是咱们键入的东西越少，那么就有越多的时间去思考代码逻辑等问题。以下所示，「Good」表示遵循该规则的示例，Bad 表示没遵循该规则的示例。
第二条：变量/函数混合命名风格
咱们须要混合命名方法与变量，这样才能体现命名的多样性。
第三条：不要写注释
反正代码都看得懂，为何要写注释？或者说，反正没人看个人代码，为何要写注释？
第四条：使用母语写注释
若是你违反了第三条规则，那么至少写注释须要用你的母语或者其它语言。若是你的母语是英语，那么你也算违反了这条规则。既然编程语言绝大多数都是用英文，那么为何不用其它语言注释一下？
第五条：尽量混合不一样的格式
一样，为了代码的多样性，咱们须要尽量混合不一样的格式，例如单引号或双引号。若是它们的语义相同，那就应该混用。
第六条：尽量把代码写成一行
若是一系列参数与方法都是一块儿实现的，那么代码也要写在一块儿。
第七条：发现错误要保持静默
当你发现某些错误时，其余人不须要了解它，所以不须要打印出日志或 Traceback。
第八条：普遍使用全局变量
使用全局变量，是面向「全球化」不可或缺的部分。
第九条：构建备用变量
以防万一，咱们须要建立一些备用变量，在须要时随时调用它们。
第十条：Type 使用需谨慎
通常不要指定变量类型或者常常作类型检查，无类型才是最好的类型。
第十一条：准备「Plan B」
你须要准备一些运行不到的代码（unreachable code），它们能够做为你的「Plan B」。
第十二条：嵌套的三角法则
若是代码有一些嵌套结构，或者说缩进空行的结构，三角法则是最漂亮的。
第十三条：混合缩进
咱们须要避免采用缩进，由于缩进会使复杂代码在编辑器中占用更多的空间。若是必定要采用缩进，那么就使用混合缩进策略。固然，这种策略在 Python 中是行不通的，由于它靠缩进来肯定代码结构。
第十四条：不要锁住依赖项
每一次要安装新库时，更新已有的依赖项。为何要维持以前的版本呢，咱们须要时刻保持最新的第三方代码库。
第十五条：长函数比短函数好
不要将程序总体逻辑分割为一些代码块，要是 IDE 忽然不行了，它找不到必要的文件或函数怎么办。所以把代码写在一个主体函数中，而且再也不维护额外的函数导入或代码文件，那么这样的方法是最稳定的。
单个文件一万行代码是没问题的，单个函数一千行代码也是没问题的。
第十六条：代码不须要作特定测试
这些测试一般是重复且无心义的工做。
第十七条：尽可能避免重复代码
按你的想法写代码，尤为是在小团队中，毕竟这是「自由」准则。
第十八条：构建新项目不须要 README 文档
在项目前期，咱们能够暂时保持这种状态。
第十九条：保存没必要要的代码
在写代码的过程当中，常常会产生不少测试代码。这些代码也是很是重要的资料，所以不能删除掉，最多只能注释掉。
扫描下方二维码
加入优质社群一块儿交流吧！
如若二维码过时
请添加小编微信,回复关键词：[进群/加群],
-今日互动-
哪条准则最深得你心呢？欢迎文章下方留言互动
若是对你有帮助的话
❤️来个「转发朋友圈」和「在看」，是最大的支持❤️
本文分享自微信公众号 - DataScience（DataScienceTeam）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。