代码整洁之道一（命名）

代码整洁之道—命名

一.概述

《代码整洁之道》是由鲍勃叔叔（Robert C.Martin）编写的著名书籍，它教我们改进编码风格，将糟糕混乱的代码转换成可读性强，干净和可维护的代码。下面就是书中部分内容。

二.好代码VS坏代码

1.命名含义需要明确：

坏代码：

int d; 
int ds;
int dsm;
int faid;

上面的代码中我们完全不知道d,ds,dsm，faid代表的是什么意思，而好代码则能一眼看出其中的含义。
好代码：

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

2. 名称误导

坏代码：

Customer[] customerList;

上面的变量“customerList”实际上并不是List，而是一个数组，但这样的命名会让人觉得customerList是List类型。

好代码：

Customer[] customers;

3. 名称过长

坏代码：

var theCustomersListWithAllCustomersIncludedWithoutFilter;

好代码：

var allCustomers;

4. 统一编码风格

坏代码：

const int maxcount = 1
bool change = true
public interface Repository
private string NAME
public class personaddress
void getallorders()

好代码：

const int MAXCOUNT = 1
bool isChanged = true
public interface IRepository
private string _name
public class PersonAddress
void getAllOrders()

5. 每个概念使用同一个词

比如获取数据时，可以用get,load,fetch,这时候就需要统一用某一个词。
坏代码：

void loadSingleData()
void fetchDataFiltered()
Void getAllData()

好代码：

void getSingleData()
void getDataFiltered()
Void getAllData()

6. 在上下文中使用有意义的名称

坏代码：

string addressCity;
string addressHomeNumber;
string addressPostCode;

好代码：

class Address
{
	string city;
	string homeNumber;
	string postCode;
}