代码整洁整洁之道读书笔记 2

第二章 有意义的命名

2.2 名副其实

名副其实说起来简单。我们想要强调,这事儿很严肃.

记得当初刚刚出道时曾写过这样的代码:

 int day;//消逝的时间,单位:天

 一开始觉得这个命名挺好的,但N久之后,当我遗忘业务逻辑的时候,再看这段代码时,就是在想不起来这个 “day”究竟是什么意思了。

如果改成“elapsedTimeInDays”会好些.这就是说我们在给函数,变量命名时要想到其他程序员(或者N久之后的自己)再看这段代码时也能体会你此时此刻的“思想意境”。

在这个环节多花几分钟,甚至几秒钟,能为将来Code View时,维护代码时带来更多的收益。前人栽树后人乘凉。

2.3 避免误导

考虑以下代码:

Account[] accountList;
List<Account> accountList;

 哪个命名好?别用 XXXList来声明一组XXX对象除非它真的是个List。

2.4 做有意义的区分

PartDetail,PartDT,PartPE,他们的都描述了Part,区别是什么?你们别以为我是随便举例,这些类还真实的存在我目前所做的项目中。

2.5 使用读的出来的名称

参考原书P21,我在这里献丑补充一点:使用使用率高的词汇,例如要写一个查找用户的方法GetUser是首选,FindUser我们也能忍,LocateinUser就一头雾水了吧。

(第二章未完...)

原文地址:https://www.cnblogs.com/windyliu/p/2441397.html