- 名副其实,变量&函数&常量的命名应该明确表示其含义,不能模凌两可。自解释代码
- 避免误导
a. 避免已有的标准命名,vim在写代码人的眼里就是编辑器,如果你用来做变量就容易引起歧义。
b. 避免类型误导,只有确实是List的时候才能命名:ListXXX - 不要用含义类似的名字来表示不同的东西,名字一定要有区分性。
- 使用读得出来的名称,读不出来不适合长期记忆
- 使用可搜索的名称,在代码里面检索某个名称是很常见的。如果给一个变量命名e,鬼知道你要花多少时间才能找到你要的那个e。
a. 名字长度应该和其作用域的大小相对应。例如:5 = WORK_DAYS_PER_WEEK vs 某个函数内的sum - 避免使用编码:有些人喜欢通过编码达到帮助记忆的效果?比如说类型|访问
a. 避免使用匈牙利标记法:一个变量名由一个或多个小写字母开始,这些字母有助于记忆变量的类型和用途,紧跟着的就是程序设计师选择的任何名称。(from wikiPedia)。如此的命名方法是在代码中进行特殊编码的一种
b. 不需要在名称前通过前缀来表明成员变量&访问。因为他们本身不具有业务上的逻辑含义
c. 接口前不要加“I”。 - 写大家普遍认知中的名称。避免思维映射:别人从你的命名的概念中映射到他们自己熟知的概念。
- 类名不应该是动词
- 方法名应该是动词或动词短语:例如:
a. postPayment,deletePage,save。 - 一个概念对应一个词。避免多个词对应一个概念或者一个词对应多个概念。
- 使用领域名称
- 添加有意义的语境。如果把变量名:firstName,lastName,street,houseNumber,city,state,zipcode。放在一起,你很容易就能联想这其中的变量其实是在表示一个地址。但是如果把他们孤立出来,就会让人摸不着头脑。
- 不需要给名字添加不必要的语境。如果你正在写一个和博物馆相关的应用。给每一个类前面加上Museum肯定不是什么好点子,这种语境天然存在。
【clean code】有意义的命名
最新推荐文章于 2022-08-22 23:18:22 发布