软件工程读书笔记1-《代码整洁之道》1

发布时间 2023-10-24 16:36:29作者: warriorschampionship

  最近读了《代码整洁之道》这本书,结合自己学习经验,对代码整洁的重要性有了一些新的理解与感悟。首先我想先谈谈什么是整洁的代码,从字面意思上理解,整洁的代码,对于程序员来说非常的一目了然,简单、整洁,结构清晰,逻辑清楚。那么整洁的代码到底对一个项目的影响有多大?对于这个问题没有明确的数据支撑我给出答案,我只知道糟糕的代码对于一个项目的影响是与这个项目的规模呈正比的,我觉得大概可以算作是呈指数级的增长。

糟糕的代码是如何影响一个项目的?想象一下一份只有10行的充斥了i、j、k等变量的代码,读完并不是一件难事,或许逻辑并不那么清晰,但是好歹还是能够理解作者的意图,但是如果变成1000行呢?或许这个数量增长到100行的时候就已经让人想要放弃,随意的命名让人一头雾水,错综复杂的逻辑混在一起。如果还要在这样的代码上继续叠加逻辑,这几乎已经是不可完成的任务了。

从我自己的经验来说,我几乎记不住代码的具体实现是怎样的,尽管这是自己所写出来的代码,在每一次进行一个新的功能的开发时,我都需要去熟悉一下旧代码的实现逻辑,然后才能在此之上进行新功能的叠加。一份整洁的代码可以让阅读它的程序员快速的了解其实现逻辑,而不需要去了解具体的实现细节。如果一份代码需要程序员了解了所有的实现细节才能知道这份代码的作用,这势必意味着程序员需要花费大量的时间在阅读一份与工作关系并不大的代码。这样的代码越多,程序员花费的时间也就越多,这就是为什么我在文章开头说糟糕的代码对于一个项目的影响是与这个项目的规模呈指数级的增长。

所以糟糕的代码意味着难以维护,也意味着代码会慢慢的腐烂。所以在完成代码后花一些时间去保持代码的整洁反而是一种提升效率的手段。

怎样的代码才叫整洁的代码呢?对于这个问题我的理解是这样的,代码其实是一种语言,传递的是逻辑,如果这份代码可以像我们说话一样快速的将逻辑传递给读者,那么这样一份代码就是一份整洁的代码。