中国领先的IT技术网站
|
|

没有对比就没有伤害,优秀的代码VS糟糕的代码

如果你还没有发现代码质量的区别,如果你从未见过优秀的代码,或者从未见过糟糕的代码,那么本文将以直观地对比,告诉你代码质量究竟会有多大的区别。

作者:佚名来源:程序师|2017-10-09 12:05

沙龙活动 | 去哪儿、陌陌、ThoughtWorks在自动化运维中的实践!10.28不见不散!


可持续开发不仅在于项目架构设计,还与代码质量密切相关,代码的整洁度和质量成正比。—— Robert C. Martin, “Clean Code”

如果你还没有发现代码质量的区别,如果你从未见过优秀的代码,或者从未见过糟糕的代码,那么本文将以直观地对比,告诉你代码质量究竟会有多大的区别。

没有对比就没有伤害,优秀的代码VS糟糕的代码

[ 代码量 ]

我们知道代码量显示着功能的复杂程度,例如Windows XP的代码量超过2000万行,Linux内核有1500万行(2012年)。然而代码量和功能数量之间并非线性关系。

优秀的设计中,代码量和功能数的关系是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

糟糕的设计中,代码量和功能数的关系是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

优秀的系统往往会有优秀的结构设计:层次清晰、职责单一、模块化,方便扩展或者复用。功能的添加往往只是在现有框架中添加少量代码。

然而糟糕的设计中,层次混乱、互相耦合、难以阅读,既难以复用又不易扩展。每当被要求添加功能时,不得不几乎完整地实现整个功能的流程,并修复与原系统的所有兼容问题。

[ 注释 ]

优秀的代码中,注释是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

糟糕的代码中,注释是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

最愚蠢的程序员都能写出机器能读懂的代码,而优秀的程序员能写出人可以读懂的代码。

程序的注释是为了让人读得懂。多数优秀的代码中,注释几乎接近代码行数的一半,描述函数功能、解释参数配置、指出陷阱所在。而糟糕的代码中不仅不含这些注释,甚至会保留大量残余代码,可读性差又难以重构。

[ 命名 ]

优秀的代码中,命名是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

糟糕的代码中,命名是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

命名是为了让代码更加容易阅读,使用规范的术语不仅更加易懂,同时也是开发者知识水平和开发经验的表现。如果说以中文拼音命名显得奇怪,那么直接以a, b, c, d命名的便会显得可恨,谁记得你的a是神马东西!

看一个经典的例子,字符串替换:

没有对比就没有伤害,优秀的代码VS糟糕的代码

没有对比就没有伤害,优秀的代码VS糟糕的代码

稍微有点Java常识的便会想到正则表达式:

何必拷贝这一堆的代码给老板看呢?开发中确实有很多时候,直接拷贝代码既能立竿见影地完成功能,又不会影响原有功能。但这样的代码多起来之后,万一功能调整你便需要重新debug所有的副本。花一些时间学习更优雅的用法是值得的。

[ 函数 ]

保持函数的短小,使你的代码更加易读,例如:

没有对比就没有伤害,优秀的代码VS糟糕的代码

将复杂的逻辑分步骤完成。如果写在一起将会是这样的:

没有对比就没有伤害,优秀的代码VS糟糕的代码

相信我,一旦你写了这样的函数,它会随着时间的推移变得越来越长,直到有一天,你也忘了其中的一段代码到底是做什么的。

事实上,复杂的函数不仅可以按照步骤划分,更应按照层次来细化。不要在一个函数中进行不同层次的操作,否则它会变得非常难懂。

【编辑推荐】

  1. LANs.py:一款可以实现代码注入,无线渗透和WiFi用户监控的强大工具
  2. Java并发编程之并发代码设计
  3. 这些优秀的主流代码编辑器,你用过多少款?
  4. 不要浪费时间写完美代码
  5. CSS 黑魔法小技巧,让你少写不必要的JS,代码更优雅
  6. Facebook 是如何进行大规模代码部署的
【责任编辑:未丽燕 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

读 书 +更多

Expert C# 2005 Business Objects中文版

本书描述了怎样应用面向对象的概念来进行.NET应用程序的架构、设计和开发。作者将重点放在了面向业务的对象,即业务对象和怎样在包括Web和...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊
× Python最火的编程语言