当前位置:首页 > 架构 > 正文内容

如何写出漂亮的代码-代码整洁之道

phpmianshi8个月前 (12-07)架构440

背景

代码本就该是直接简单的,横就是横,纵就是纵,架构原本也本是清晰明了的,模块是模块,过程是过程。

可随着项目生命周期的变长,随着需求不断的被实现,面对不同思想的人,不同场景的要求,不同技能水平的实施,就让原本平直的路走成了立交桥,织成了逻辑网。这时候再浏览代码,要走通某一个流程,即便是熟悉路况的“本地人”,编写代码的“原住民”也不一定能走的顺畅。

Robert Martin的这句话非常合适:

“唯一能有效测量代码质量的方式是每分钟说多少个What-the-Fk ”

让我深入解释一下:

做代码回顾的时候,我的脑海会涌现出三种不同的情绪:

· What-the-Fk (厌恶)—这代码并不需要.**

· What-the-Fk (欣赏)— 小伙子很机智**

· What-the-Fk (无奈)—不知道在说什么**

所以当我们看代码的时候,是什么最先影响我们呢?是代码的整洁漂亮。同时书写整洁漂亮的代码是一名伟大的软件匠人的标志。

命名


Kendrick Lamar很好的解释道:

”如果我要讲一个真实的故事,我会从我的命名开始“

我们命名函数、类、参数、包以及其他。

你的命名应该望文知义。选择好的名称会花时间,但是当其更艰难复杂的时候却可以节省更多时间。所以注意你的命名,如若有合适的名字就替换掉。每个阅读你代码的人都会因此而很感谢你。

牢记变量、函数或者类的名称应该要回答这三个大问题:存在的理由?做了什么?和如何使用?

函数只做一件事


这里有两条书写整洁函数的黄金定律:

· 代码应该少

· 函数应该专注做一件事,并且做精

所以这也意味着你的函数不应该太大来嵌套其他结构。同时,函数的缩进,不应该大于一个或者两个。该技巧可以使得代码更容易阅读理解消化。除此之外,我们也要使得函数内的语句处于同一个抽象程度。

注释并不能弥补劣质的代码

Venus Williams曾很好地说道:

“每个人有自己的注释,这就是谣言开始的方式”

注释就像两面刀。没有什么比得上放置妥当的注解。另一方面,没有比无聊无用的注解更浪费空间的。同时没有比传递错误信息的注解更具有破坏力的。

简而言之,注释至多是个必要的恶魔。为什么这么说?虽然不是一直但是大部分时候,注释越老,维护起来越困难,大部分程序员都因为不维护注释而臭名昭著。

代码移动和更改:代码块移动到其他地方,而注释不随着移动,就会成为一个问题!

要牢记,带有一点注释并且整洁和有表现力的代码,要远远好过复杂并带有大量注释的代码。不要浪费时间去解释你写的代码,而去投入时间去使其整洁。

重构清晰代码的技能习惯

没有人一开始就能写出优美散文一样的代码,整洁的代码是用心重构出来的。

不清晰的代码总是会触犯标准,对临床医学来讲病人生什么病,开什么处方,吃什么药是有章可循的。坏代码违反整洁标准的哪一条,就使用哪一条的处方来修改。这个修改的处方和药是可以积累和总结的,而且有已经总结好的经验。剩下的是学习和养成习惯。

对已有代码的整洁化不是大范围的重写,是在保证不影响已有功能的前提下坚持做的改进优化。

唯有源头活水来,甲严格执行整洁之道的准则,乙坚持己见,丙随意而为,即使甲有熟练的整洁技能和习惯也改不完项目的所有问题。

对编程来讲,一个人的习惯是能力,一个团队的能力才是习惯。

CleanCode之道


381412-20181122135844764-490139841.png


版权声明:本文由PHP面试资料网发布,如需转载请注明出处。
分享给朋友:

相关文章

系统架构的演进之路-单体到SOA到微服务

单体系统的困难在微服务出现之前,互联网应用系统主要是单体系统,也就是说一个网站的整个系统由一个应用构成。如果是 Java,就打包成一个 war 包,一个 war 包包含整个应用系统,系统更新的时候,即...

高性能网络编程中的I/O模型

高性能网络编程中的I/O模型

互联网服务端处理网络请求的原理首先看看一个典型互联网服务端处理网络请求的典型过程由上图可以看到,主要处理步骤包括:1. 获取请求数据,客户端与服务器建立连接发出请求,服务器接受请求(1-3);2. 构...

微博朋友圈亿级Feed流如何设计

微博朋友圈亿级Feed流如何设计

简介Feed流是Feed + 流,Feed的本意是饲料,Feed流的本意就是有人一直在往一个地方投递新鲜的饲料,如果需要饲料,只需要盯着投递点就可以了,这样就能源源不断获取到新鲜的饲料。 在...

大型系统高可用的一般策略

负载均衡首先是应用服务器的负载均衡。负载均衡核心要解决的就是通过一个负载均衡服务器,将用户的请求分发给多个应用服务器,将多个应用服务器构建成一个集群,共同对外提供服务。这样的架构可以提高系统的处理能力...

单台服务器并发TCP连接数到底可以有多少

常识一:文件句柄限制在linux下编写网络服务器程序的朋友肯定都知道每一个tcp连接都要占一个文件描述符,一旦这个文件描述符使用完了,新的连接到来返回给我们的错误是“Socket/File:Can&#...

如何实现分布式事务及BASE和CAP理论

事务定义简单地说,事务提供一种“要么什么都不做,要么做全套(All or Nothing)”机制。数据库本地事务数据库事务中的四大特性 ACIDA:原子性(Atomicity),一个事务(transa...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。