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

简介:

可持续开发不仅在于项目架构设计,还与代码质量密切相关,代码的整洁度和质量成正比。—— 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糟糕的代码

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

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


本文作者:佚名

来源:51CTO

相关文章
|
5月前
|
供应链 测试技术
修复糟糕的代码气味
修复糟糕的代码气味
61 11
消除代码坏味道
读完本章的收获:代码规范、代码可读性、鲁棒性的代码好坏案例,写出好代码的能力。
消除代码坏味道
|
编译器 C语言
源于《C陷阱与缺陷》----研究程序死循环问题
所以最后答案应该就是打印了12次xiao tao,然后越界访问出现错误,使arr[10]=0,arr[11]=0了 但最后答案却不是这样。
119 0
|
Java C语言
看似无害的代码如何搞垮系统
编程就像魔法。最近遇到一个诡异的问题:添加一段看似无害的简单代码后,系统原有功能不可用了。 ## 复现演示 jdk 8 可使用如下演示代码复现这个问题。 `TaskCenter` 是一个任务框架,可添加多个任务,随后框架将执行这些任务。 `First` 任务是新增代码,看起来简单无害,且看不出对原有任务 `Count` 有何影响,但添加 `First` 任务后,其自身执行正常,原本正常的 `C
129 0
Zp
|
XML 算法 IDE
提升:抛弃七条不良编码习惯
提升:抛弃七条不良编码习惯
Zp
124 0
|
存储 Java
一个极易被忽略的内存泄漏情况,看看你会不会犯一样的错
Java之所以能够成为世界上最受欢迎的语言,与其垃圾回收机制分不开。我们Javaer能够在创建完对象后就不用管她的生死,确实是十分方便(真特么是个渣男)。可是有时候因为你创建了她,又对她爱答不理,就很有可能出大问题。
|
Web App开发 JavaScript 前端开发
容易忽视的前端陷阱
1 CSRF CSRF(Cross Site Request Forgery)是伪造客户端请求的一种攻击,字面上的意思是跨站点伪造请求 CSRF的定义是强迫受害者的浏览器向一个易受攻击的Web应用程序发送请求,最后达到攻击者所需要的操作行为。
895 0
|
测试技术 数据库