一句老话:好代码千分之一,坏代码千分之一。作为一个开发者,除了我自己写的,别人的代码在我眼里多半是“烂代码”。但是由于资质不足,烂代码不多,也没有总结出规律。但是GitHub上的这个项目实现了我多年的梦想。JunkCodeWritingGuidelines这个项目实际上是一个垃圾代码编写指南的列表,共有19条指南。该项目目前在GitHub上有600+个Star。我认为它的潜力绝对不止于此。原则”,不要搞错~1.变量命名方式容易混淆如果我们敲的东西少一点,那么我们就有更多的时间去思考代码逻辑等问题。如下图,没有人知道将变量命名为“a”意味着什么。相反,将其命名为“age”只是一种常见的事情。2.混合变量/函数命名风格庆祝差异。大多数人将变量名和函数名设置在同样的格式,但是使用不同的风格,不仅可以体现我们的编码能力,还可以体现我们的命名能力,一石二鸟。3.不要写评论。作者给出了正式的抱怨:没有人会读你的代码anyway,为什么要写注释?这个我是认真的“无评论”原则,至少尽量用不同的语言写评论nt来自您用来编写代码的那个。例如,母语为英语的开发者可以使用日语、韩语或俄语进行注释,实现在编写代码的同时学习外语。我们国内的开发者也可以尝试写一些小语种的评论,毕竟我们是一群神秘的人。5.尽可能混合庆祝不同的格式。在符合代码规范的情况下,尽量混合使用不同的格式,比如例子中的单引号和双引号。6.代码尽量写成一行。相信大家都看过那些“一行代码xxx”,为什么别人实现一行代码就觉得很酷,而我们一行就写不出来呢?7.不要处理错误。每当您发现错误时,都无需让任何人知道。没有日志,没有错误弹框。8.大量使用全局变量。作者说,这符合全球化的原则。它是有道理的并且有一个模式。9.建立你不需要的变量以防万一。虽然现在不用,但是以后会有用的?abc是铁三角,永远分不开。10.如果语言允许,不要指定类型和/或不执行类型检查。没有类型是最好的类型。11.你应该有不能作为“B计划”运行的代码。你需要有一些不能运行的代码,这意味着你做了额外的思考。12.三角函数如果写代码是一门艺术,那么三角函数显然是最具艺术设计感的。13.混合缩进避免缩进,因为它们会使复杂的代码在编辑器中占用更多空间。如果您不喜欢躲避它们,请随意使用混合缩进策略。(这个不能再洗了)14.不要锁定你的依赖,以不受控制的方式更新每一个新安装的依赖。为什么坚持使用过去的版本,让我们使用最先进的库版本。15.长函数比短函数好。不要将程序逻辑分成代码块。如果IDE的搜索停止而您找不到所需的文件或函数怎么办?一个文件10000行代码就OK;一个函数体1000行代码就OK;在“service.js”中处理许多服务(第三方和内部,还有一些工具,数据库手写ORM和jQuery滑块)?还可以。16.不要测试你的代码。这是重复和不必要的工作。17.避免代码风格的统一写你想要的代码,尤其是当你的团队中有多个开发人员时。这是一个“免费”的原则。不特别,如何体现自己的特立独行!18.构建新项目不需要README文件。从一开始就应该保持不写README的好习惯(本GitHub项目没有README,作者也是知行合一)。19.保存不需要的代码不要删除不需要的代码,最多注释掉。毕竟,我们编写的每一行代码都是我们流下的汗水。如果我们删了,别人怎么知道我们写了呢~玩的开心,闹就闹,别拿工作开玩笑。是人读的,机器顺便执行的。”我觉得有道理,虽然代码是机器语言,但还是要人去使用和调试,所以还是要符合人的需求和设计思路最大程度的看了这么多糟糕的代码设计规范,其实是涂一乐。我们也可以从这些糟糕的代码规范中学习到,想要写出优秀的代码,我们应该避免踩哪些坑。以下是收集的一些资料,大家可以先收藏起来,没事的时候看看,争取大家写出好的代码~
