手牵手教你写代码,从入门到精通

如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等 。
 
但是对于什么是烂代码,你有比较清晰的认识吗?
 
在 GitHub 上有一个新项目,它描述了「最佳垃圾代码」的十九条关键准则 。从变量命名到注释编写 。这些准则将指导你写出最亮眼的烂代码 。
 
为了保持与原 GitHub 项目一致的风格,下文没有进行转换 。读者们可以以相反的角度来理解所有观点,这样就能完美避免写出垃圾代码 。
 
repo 地址: https://github.com/trekhleb/state-of-the-art-shitcode
 
当然,以下十九条垃圾代码书写准则并没有面面俱到,如果读者们发现有一些难以忍受的烂代码习惯,也可以留言发表你的看法 。
 
第一条:打字越少越好
 
如果我们键入的东西越少,那么就有越多的时间去思考代码逻辑等问题 。如下所示,「Good」表示遵循该规则的示例,Bad 表示没遵循该规则的示例 。
 

手牵手教你写代码,从入门到精通

文章插图
 
第二条:****变量/函数混合命名风格我们需要混合命名方法与变量,这样才能体现命名的多样性 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第三条:****不要写注释反正代码都看得懂,为什么要写注释?或者说,反正没人看我的代码,为什么要写注释?
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第四条:****使用母语写注释如果你违反了第三条规则,那么至少写注释需要用你的母语或者其它语言 。如果你的母语是英语,那么你也算违反了这条规则 。既然编程语言绝大多数都是用英文,那么为什么不用其它语言注释一下?
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第五条:****尽可能混合不同的格式同样,为了代码的多样性,我们需要尽可能混合不同的格式,例如单引号或双引号 。如果它们的语义相同,那就应该混用 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第六条:****尽可能把代码写成一行如果一系列参数与方法都是一起实现的,那么代码也要写在一起 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第七条:****发现错误要保持静默当你发现某些错误时,其他人不需要了解它,因此不需要打印出日志或 Traceback 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第八条:****广泛使用全局变量使用全局变量,是面向「全球化」不可或缺的部分 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第九条:****构建备用变量以防万一,我们需要创建一些备用变量,在需要时随时调用它们 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第十条:****Type 使用需谨慎一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第十一条:****准备「Plan B」你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第十二条:****嵌套的三角法则如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的 。
 
手牵手教你写代码,从入门到精通

文章插图
 
 
第十三条:****混合缩进我们需要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间 。如果一定要采用缩进,那么就使用混合缩进策略 。当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构 。
 
手牵手教你写代码,从入门到精通

文章插图


推荐阅读