程式碼整潔之道—命名

一.概述

《程式碼整潔之道》是由鮑勃叔叔（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;
}