代码整洁之道-读书笔记(二) 第二章 有意义的命名

    第二章主要讲述的是命名的技巧和重要性。

    文中提到的好名字的几条规则:

 1、名副其实:每个名字都和他具体实现的功能有关,做到看到这个名字就能知道它是用来做什么的。

 2、避免误导:避免使用与本意相悖名字以至于对读程序的人造成误导。还有一个误导的典型例子是字母l和O作为变量名,会与数字1和0混淆从而造成误导。

3、作出有意义的区分:a an 的区分就没有意义,如果两个变量或者函数的功能不同,明明也应该看书显著地不同。

4、使用读得出来的名字:无法读出来的名字不便于沟通,所以不要使用傻乎乎的自造词,使用有意义的、能读出来的名称会更好一些。

5、使用可搜索的名称:单字母的名称和数字常量的一个问题就是很难在一大片文字中找出来,比如你在一大段中程序中搜索7,很难找出你想要的那个,所以让名称长一些会比较好找,名称长短应与作用域大小相对应,短名称比较适用于短作用域的场景。

6、避免使用编码

7 、避免思维映射:明确是王道。

8、类名:应当是名词或者名字短语,不应当是动词

9:方法名:应当是动词或者动词短语

10、别扮可爱:不要用抖机灵的名字,不便于理解

11、每个概念对应一个词: 给每个抽象概念选一个词,并且一以贯之。

12、避免双关语:避免将同一单词用于不同目的。

13、使用解决方案领域的名称:代码是写给程序员看的,所以尽量使用CS领域的术语。

14、使用涉及领域的名称:对于CS领域没有的术语,可以使用问题设计领域的术语,这样方便程序员不懂的时候去问相关人士。

15、添加有意义的语境:结合语境更容易理解名称。

16、不要添加没有意义的语境。

猜你喜欢

转载自blog.csdn.net/weixin_42275416/article/details/80533781