《代码整洁之道》笔记01——有意义的命名

有意义的命名

名副其实

例如代码中如果出现thsList,theArray这些命名,应该赋予更加具有实际用途的命名。

比如用于保存用户名的数组:usersNameArray

避免误导

避免留下掩藏代码本意的错误线索。例如:

  1. 使用了语言的预留的变量名
  2. 使用了与系统设计有误导的命名:userNameList如果这个变量名不是一个List类型
  3. 使用大写的O小写的l来命名变量,使之看起来像数字的 0,1

有意义的区分

给相似属性设置变量名是,需要从意义上做区分命名:

moneymoneyAmount区别不是很大

getUserInfogetUserMessagegetUsers,这些函数其实有点模糊,程序员怎么能从名字就知道这个函数的具体意义?

可读的命名

例如程序中有一个变量保存着出生日期(年,月,日)的数据使用了yearMonthsDay,虽然这个的确“有意义”,同时也有点“搞笑”,因为它并不符合语法,属于程序员的自造词,所以这也是不太合适。

使用可搜索的名称

有时候在程序编写时,需要使用常量与长字母名称,目的是为了方便搜索,当然这些主要是用于一些比较特别的需求,例如保存者全局状态的标识等。

避免使用编码

尽量避免使用其他编码的语言,这样会给解码带来负担。例如:成员前缀(旧时代的产物),接口实现前缀使用IName中的I是冗杂的。

避免思维映射

程序员应当避免过度“思维上的想当然”,比如在循环计数器上,程序员常用的是i,k,j这些短变量名,当然你也可以使用a,b,c来替代。但是这样比起i,k,j而言,这几个变量能够让其他程序员更明确知道这些变量是计数器变量。专业的程序员知道:明确既是王道,应当编写出其他人能够理解的代码。

类名

开头首字母大写,不应当出现动词。

方法名

方法名应当是动词或者动词短语,避免出现一些俗语,应当以明确为主。

一个概念对应一个词

避免出现一种操作多种词语形容,例如:contraollermanager这2个词语就会令人疑惑,这样应该在一个类中或者一个模块中选择一个来代表一个概念。

避免歧义名称(双关语)

例如给数组增加一项数据,有从头部、尾部、指定位置添加的区别,如果使用add其他程序员需要理解下代码才知道这是头部还是尾部添加,所以可以使用appendinsertunshift等来替代,让其他程序员一目了然。

使用解决方案领域的名称

记住,只有程序员才会阅读你的代码,所以,尽管使用计算机领域的术语、名称、模式名与数学属于吧。

使用源自所涉问题领域的名称

当上一个解决方案领域名称不能满足的时候,就采用从所涉问题领域来进行命名,至少程序员可以通过请教该问题领域专家。

添加有意义的语境

很少有名称能自我说明,可以通过良好命名的类、函数、名称空间来放置名称,给读者添加一定的语境加以声明。如果没这么做,给名称添加前缀是最后一招。

去除无意义的语境

比如:如果你的变量已经在一个GasStationDeluxe类之中了,就无需在所有变量前再添加GSD来表示说明。

小结

命名的进步需要经过一个长久的锻炼才能进步的,并不是通过看几段代码演示即可掌握的好。一个好的命名习惯是写好代码的基础。

你可能感兴趣的:(一些学习的研究,代码整洁之道)