第四次读书笔记

编写可读代码的艺术读书笔记

这本书主要讲了代码的一些编码规范和养成一些编码过程中的好习惯。

关于变量取名字,应该让名字携带上更多的信息,而不是给糟糕的命名添加注释。给变量名带上重要的细节可以带上单位的值或者附带其他重要的属性。同时,可以使用大小写和下划线来区分共有变量和私有变量。此外,变量命名不应该使用可能会造成误解的名字。尤其是布尔值,应该给布尔值自己的名字而不是直接使用FALSE或者TRUE。这一点和不适用无意义的数字有相同的效果。名字应该尽量专业,不空泛,例如避免t之类的变量名。

在代码中,应该保持个人风格的一致性,不同代码段之间应当用空格分开形成段落。不同层次之间代码的缩进也是很重要的。这可以让代码易于理解和阅读。同时,要把意义相似的代码块组织起来使用,类似于把声明按块组织起来。但是变量的定义应当尽量靠近使用的地方,方便理解。

关于注释,注释应该添加一些必要的东西,而非为了注释而注释。常量需要添加注释来理解,要做的事情,采取某种方法的原因需要添加一些注释,对某些事情的总结性和有助于全局性理解的地方应该添加注释。

关于控制流,要把左侧的值作为倾向于变化的值,右侧的值倾向于常量,if/else中应该先处理正逻辑或者简单的情况。为了让流显得自然,应当尽量避免函数中的提前返回。

不相关的代码进行分割,把普通代码和特殊代码分隔开,可以采取的方法有创造大量通用代码,简化已有接口等。对于一个函数,应该让他的功能尽量单一化,即减小函数之间的耦合。一次只做一件事情。

原文地址:https://www.cnblogs.com/blazersforever/p/8677640.html