代码整洁之道要点(一)

本系列出自于本人看过《代码整洁之道》后总结的一部分要点。 非常感谢这本书给我和广大程序员带来的快乐!
注: 需要该书电子版的朋友请私信我。
推荐歌曲:Try - Marlisa

阅读本书的原因
第一,你是一个程序员;第二,你想成为更好的程序员。

整洁代码的艺术
编写整洁代码的程序员就像是艺术家,他能用一系列变换把一张白块变作由优雅代码构成的系统。

什么是整洁代码
一种优雅和高效的代码。
优雅的代码不仅让代码看起来优美雅观,并且令人愉悦。

一个老笑话
一个小提琴家在去表演的路上迷路了,他在街角拦住一位长者,问他怎么才能去卡耐基音乐厅(Carnegie Hall)。
长者看了看小提琴家,又看了看他手中的琴,说道:“你还得练,孩子,还得练!”

让代码命名名副其实
变量、函数或类的名称应该已经答复了所有的大问题。
如果通过一个名称就能让大家知道,它为什么存在、做什么事情、应该怎么用,那么这个命名就做到了名副其实。

使用可搜索的长名称
将代码中出现的单字母名称和数字常量用长名称变量声明起来,可以方便搜索。
同时,名称的长短应于其作用域大小相对应。

尽量不使用成员前缀
非必要的情况下,不要使用类似m_的前缀,而应该把类和函数做得足够小,消除对成员前缀的需求。

类名
类名和对象名应该是名词或名词短语。

方法名
方法名应当是动词或动词短语。

别用双关语
同一术语用于不同概念,基本上就是双关语了。

短小的函数
函数的第一规则是要短小,第二规则是还要更短小!(有点不对劲~)

专一的函数
函数应该做一件事。
以及,做好这件事。
并且,只做一件事。

每个函数一个抽象层级
要确保函数只做一件事,函数的语句都要保持在同一抽象层级上。

函数参数个数不应过多
最理想的参数数量为零,其次是一,再次是二,最后应避免三。
有足够特殊的理由才能用三个以上的参数,否则无论如何也不要这么做。
从测试的角度看,参数更叫人为难。过多的参数导致测试覆盖的所有可能值的组合让人生畏!

使用异常代替返回错误码
如果使用异常代替返回错误码,错误处理代码就能出主路径代码中分离出来,并得到简化。

抽离Try/Catch代码块
Try/catch代码块搞乱了代码结构,把错误处理和正常流程混为一谈。最好把try和catch代码块的主体部分抽离出来,另外形成函数。

猜你喜欢

转载自blog.csdn.net/weixin_44737486/article/details/122670297