代码整洁之道：有意义的命名

名副其实

1. 如果名称需要注释来补充，那就不是名副其实

• bad

int d; // 消逝的时间，以日计

• good

int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

避免误导

1. 别留下掩藏代码本意的错误线索

• bad
  accoutList
  除非它真的是List类型
• good
  accountGroup
bunchOfAccounts
accounts

2. 提防使用不同之处比较小的名称
   对于
   XYZControllerForEfficientHandlingOfStrings
XYZControllerForEfficientStorageOfStrings
   难以分辨
3. 避免使用小写字母l和大写字母O作为变量名

做有意义的区分

1. 避免光是添加数字

• bad 以数字系列命名
  （a1、a2 .... aN）完全没有提供有效信息，没有提供导向作者意图的线索

public static void copyChars(char a1[], char a2[]){
  for (int  i = 0; i<a1.length; i++)
    a2[i]  = a1[i];
  }
}

• good
  a1 -> source
a2 -> destination

2. 避免以废话命名

• bad
  已经有一个Product类，如果还有一个ProductInfo类 或 ProductData类，虽然名称不同，但意思却没有区别，Info和Data是意义混淆的废话

使用读得出来的名称

1. 使用可读的单词做命名，而不是自造不可读的词

• bad

class DtaRcr102 {
  private Date genymdhms;
  private Date modymdhms;
  private final String pszqint = "102";
};

• good

class Customer {
  private Date generationTimestamp;
  private Date modificationTimestamp;
  private final String recordId = "102";
};

使用可搜索的名称

1. 单字母名称和数字常量会很难在一大篇文字中找出来
2. 长名称胜于短名称
3. 名称长短应与其作用域大小相对应，单字母名称仅用于短方法中的本地变量

• bad

for (int j=0; j<34; j++) {
 s += (t[j]*4)/5;
}

• good

int realDaysPerIdealDay = 4;
const int WORK_DAYS_PER_WEEK = 5;
int sum = 0;
for (int j=0; j < NUMBER_OF_TASKS; j++) {
  int realTaskDays = taskEstimate[j] * realDaysPerIdealDay;
  int realTaskWeeks = (realdays / WORK_DAYS_PER_WEEK);
  sum += realTaskWeeks;
}

避免使用编码

1. 不宜用m_前缀标明成员变量，应当用某种可以高亮或用颜色标出成员的编辑环境

避免思维映射

1. 不应当让读者在脑中把你的名称翻译为他们熟知的名称。例如i,j,k常被用于循环计数中，而不适合用于别的场合

类名

1. 类名和对象名应该是名次或名词短语，如Customer、WikiPage、Account
2. 避免Manager、Processor、Data或Info这样的类名。

方法名

1.方法名应当是动词或动词短语，如postPayment、deletePage或save

2. 属性访问器、修改器和断言应该根据其值命名，并加上get、set、is的前缀

• good

string name = employee.getName();
customer.setName("mike");
if (paycheck.isPosted())...

3.重载构造器时候，使用描述了参数的静态工厂方法名

• bad

Complex fulcrumPoint = Complex.FromRealNumber(23.0);

• good

Complex.fulcrumPoint  = new Complex(23.0);

别扮可爱

• bad

HolyHandGrenade

• good

DeleteItems

每个概念对应一个词

1. 给每个抽象概念选一个词

• bad
  fetch、retrieve、get

别用双关词

使用解决方案领域名称

1. 用程序员熟悉的术语命名

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

1. 优秀的程序员和设计师，其工作之一就是分离解决方案领域和问题领域的概念。与所涉问题领域更为贴近的代码，应当采用源自问题领域的名称。

添加有意义的语境

1. 用有良好命名的类、函数或名称空间来放置名称，给读者提供语境
2. 如果1做不到，那就给名称添加前缀。

• bad

firstName
lastName
street
houseNumber
city
state
zipcode

• good

addrFirstName
addrLastName
addrState...
或者是创建名为Address的类

不要添加没用的语境

• bad
  有一个名为“Gas Station Deluxe”的应用，然后给每个类加GSD前缀

这样会得到系统中全部类的列表，冗长得无法选择

• good
  对于Address类的实体来说，accountAddress和customerAddress都是不错的名称，不过用在类名上就不太好了。