代码简洁之道——有意义的命名

来源:互联网 发布:淘宝客网站 编辑:程序博客网 时间:2024/05/16 05:44

总觉得自己的代码写的太差,可是又不知道如果改进,特买来鲍勃大叔的“代码简洁之道”细细品读,收益颇深,以下是整理的一些笔记,用于警醒自己;

第二章:有有意义的命名

(1)名副其实:即我们看到一个类、函数、变量的名字就知道它用来做什么的(英文太差,项目中各种中文拼音,伤不起,以后坚持用英文);

(2)避免误导:例如我们想表达一组账号的意思,可能会有accountList,这就容易引起误导误以为accountList是一个List类型的变量,这时用accounts或bounchOfAccounts会好的多;

(3)做有意义的区分:在读者看来Product、ProductInfo、ProductData没有明确的区分;

(4)使用读的出来的名称:这样不见便于记忆和理解,也便于同事之间的讨论与交流,总不能和同事讨论的时候说“呀呀,那个不能这么写,这个不能这么弄”,谁知道谁是谁呢;

(5)使用可搜索的名称:名称的长短应与其作用域相对应;

(6)避免使用编码;

(7)避免思维映射:不应当把你熟知的一些专业领域的名称强加到读者身上,可能读者对这一领域一无所知,明确才是王道;

(8)类名:应该是名词或名词短语;

(9)方法名:是动词或动词短语;

(10)别扮可爱:killItems和DeleteItems哪个更好,显而易见;

(11)每个概念对应一个词:同一堆代码中既有contorller,manage又有dirver会使人很困惑;

(12)别用双关语;

(13)使用解决方案领域的名称(技术);

(14)使用源自所涉及问题领域的名称(业务);

(15)添加有意义的语境;

(16)不要添加没用的语境。

0 0
原创粉丝点击