《代码整洁之道》 读书笔记

《代码整洁之道》

读书笔记

娄雨禛 PB16060356

 

　　在我看来，每一位优秀的程序员都有一份义务，将自己的代码写得整洁易读。这可以算是一种必须有的“强迫症”——因为这不仅是对他人负责，更是对自己负责。

　　在《代码整洁之道》一书中，我了解到了许许多多增强代码整洁性的小技巧。下面先对我所了解到了做一个总结。

　　不要过分依赖注释，因为注释拯救不了糟糕的代码

　　在面对一个项目的时候，我需要首先考虑代码本身的书写，然后在此基础上用注释使代码更加易读。我犯过这样的错误，即过分关注于注释本身，甚至一行代码一行注释。结果很显然，不仅编程效率极低，而且因为没有在代码本身投入足够多的关注度，代码本身的质量非常低下。

　　首先用代码本身去表达，其次才是注释

　　在编程语句中，经常会用到if语句。我有时会强迫症突发地补加注释，把明明已经很显然的语句再注释一遍。这样的做法正是犯了避重就轻的错误。其实，良好的变量命名就已经能使代码在第一眼就被理解，而无需再加注释。

　　善用注释表达宏观意图

　　这是我做得很不好的一点。我总是用注释注解一些很小的语句，而在宏观层面却没有一句注释。其实，良好的代码总是在关键性的函数或语句之前有着思维引导性的注释语句，这样的做法有助于阅读者快速跟上编程者的思路，从而理解整个程序架构。

　　尽量减少注释的复制粘贴行为

　　这样做的原因很简单：简单的复制粘贴很可能会产生错误的注释，因为它们没有被及时修改。我总是贪图一时的爽快，在需要相似的注释时直接复制粘贴。结果，由于程序的相似性，上下翻页滚动时忘记了哪些地方被粘贴了，于是就留下了错误的注释。这种错误看似很小，却很可怕，一定要注意。

　　良好的变量名是成功的一半

　　在结对编程的过程中，我们变量名非常紊乱，这为我们的后续漏洞修复造成了不小的麻烦。我们总在一开始想要偷个懒，写得快一点，却反而导致了后面时间的浪费。因此，在最开始，就要有一个宏观的布局。而这种布局中最基本的一点，就是为所有的变量起一个良好的变量名。

　　使用异常而非返回值

　　在初学C语言的时候，我们总是用-1来代表某种错误的发生。这样的操作在“异常”被引入之后就应当停止了。然而，因为对异常的使用并不熟练，我总还是在使用返回值报错，这样的行为应当不断减少。

　　不要返回NULL值

　　如果我们在函数的最后由NULL值的返回，那么就需要在它的接受函数中不断检查值是否为NULL。这样的操作很冗杂，很多余。

　　在最后，我想结合之前的个人作业和结对作业做一个小小的总结。

　　在个人作业中，我过度注重代码的局部注释，使得不必要的注释花去了我大把的时间，而有意义的宏观注释没有被良好地建立起来。通过阅读本书，我懂得了如何写出良好的注释，从而更高效地维护代码。

　　在结对作业中，我们在变量的命名上做得很差，导致后面很多地方在浪费时间。良好的变量命名应当在一开始就建立起来。