【代码整洁之道】第二章：有意义的命名

第二章 有意义的命名

2.1      介绍

要命名的地方很多，好的命名很重要。

2.2      名副其实

从变量、函数或类的名称就应该能看出来“它为什么存在，它做什么事，它该怎么用”。做到见名知意。

2.3      避免误导

避免使用与本意相悖的词来命名。容易误导。

避免使用差异较小的词语来命名。不易区分。

避免使用“l”和“o”做变量名。容易混淆。

2.4      做有意义的区分

避免用数字序列命名。

2.5      使用读得出来的名称

命名要能读出来，方便交流。

2.6      使用可搜索的名称

避免使用单个字母或数字，不易搜索。

2.7      避免使用编码

2.7.1          匈牙利标记法

不要把变量类型放进变量名。影响阅读。

2.7.2          成员前缀

不要给成员变量加前缀，没意义。

2.7.3          接口和实现

区分接口和对应的实现类时，可给实现类加后缀“Impl”。

2.8      避免思维映射

2.9      类名

类名和对象名建议用名词或名词短语。不要用动词。

2.10   方法名

方法名建议用动词或动宾短语。属性操纵器可加get，set，is前缀。

2.11   别扮可爱

不要用俗语、俚语命名，自己觉得好玩儿，他人却不易懂。

2.12   每个概念对应一个词

每个概念始终用同一个词表示。

2.13   别用双关语

不要用同一个词表示不同的目的。

2.14   使用解决方案领域名称

优先使用IT界的术语命名。

2.15   使用问题所涉领域名称

IT术语不便使用，可使用问题域的术语。

2.16   添加有意义的语境

可给命名加前缀，使其易于理解。

2.17   不要添加没用的语境

不要让没意义的词参与命名。

2.18   小结

取个好名字在于需要良好的描述技巧和文化背景。本章提到了一些技巧以供参考。