概述

代碼是從命名開始的，我們給類、方法、變數和參數命名，我們也給解決方案、工程、目錄命名。在編碼時，除了應該遵守編程語言本身的命名規範外，我們應該提供好的命名。好的命名意味著良好的可讀性，讀你代碼的人無需太多的註釋，就能通過名稱知道它是什麼，它能做什麼事兒，以及它應該怎麼用。

我們命名、命名，不斷地命名。既然有這麼多命名要做，我們不妨做好他。

關於命名

取名字的成本

取個名字很簡單，取個好的名字就不那麼容易了。快速隨意地取個名字，還不如花點時間取個好名字，因為好名字省下來的時間要比花掉的多。

好的命名的關鍵是有意義

可以從以下幾點出發，去取個有意義的名字。（以下內容，總結自《Clean code》）

• 名副其實：名稱本身應該告訴了你“它是誰？它是做什麼的？它該怎麼用”，如果名稱需要註釋來補充，則是名不副實的。
• 避免誤導：提防使用差異較小的名稱，例如：你在ProductService中提供了3個方法，GetProducts，GetProductInfo和GetProductList。這3個名字可能是在不同場景下使用的，調用者要獲取產品信息時，到底該用哪個名字呢？如果你通過註釋來描述這3個方法的使用場景，那就是名不副實。
• 做有意義的區分：如果缺少明確的約定，GetProducts，GetProductInfo和GetProductList是沒有區別的。在程式中最好制定一個規則，例如通過“Get + 名詞複數”的方式獲取批量信息，那麼在ProductService中就應該只能出現GetProducts方法。
• 使用可搜索的名稱：可搜索的名稱，意味著在修改代碼時，你可以通過全文搜索找到它們。例如：訂單審批的狀態，你通過1、2、3、4這些數字來表示，還不如通過NewCreated、Approving、Approved、Rejected來表示，它們既有實際意義，也更容易搜索。
• 每個概念對應一個詞：Fetch, Retrieve和Get都表示“獲取”，如果你用這些詞為同種方法命名，請取其一，並作為命名規則貫徹實行下去。
• 添加有意義的語境：很少有名稱是能自我說明的，你需要用良好命名的類、函數或命名空間來放置名稱，給讀者提供語境。如果沒有這麼做，則可以給名稱添加首碼。假設你有firstName、lastName、street、houseNumber、state這些變數，當它們放一起的時候，很明確地構成了一個地址。但當你在某個方法中看到單獨state變數時，state既能表示“狀態”，又能表示“州”，你能推算出它的含義嗎？你可以為變數添加首碼，addrFirstName, addrLastName和addrState等，這樣就提供了明確且有意義的語境。

以上這些point，是除了編程語言本身的命名規範之外，你需要額外考慮的。不好的命名能混淆程式員的認知，給開髮帶來很多困擾。好的命名也不是一刻就能實現的，有時候限於你對系統和業務的理解，你可能難以給定一個“精確”的名稱，但隨著你掌握更深的業務，那些不好的名稱你應該再反覆推敲並調整。

示例

前面講了那麼多關於“命名”的事兒，都是為本文要講的重構策略“重命名”做鋪墊。

如果你使用Visual Studio開發程式，你可以藉助一些工具來重命名，例如Resharper，這個工具還提供了良好的命名建議。

重構前

下麵的代碼為了描述員工的姓名和計算小時收入的方法。

public abstract class Person
{
    public string FN { get; set; }

    public decimal ClcHrlyPR()
    {
        // code to calculate hourly payrate
        return 0m;
    }
}

很顯然，這段代碼提供了難以理解的命名。

重構後

於是對這段代碼做了3處重構：

• 將Person類重命名為Employee。"Person"的含義太寬泛，"Employee"則能體現員工的概念。
• 將FN屬性重命名為FirstName。"FN"沒有提供確切的語義，它是什麼單詞的縮寫？是"File Number"(檔案編號)，還是Frost Nova(霜凍新星)？
• 將ClcHrlyPR()方法重命名為CalculateHourlyPay()。"ClcHrlyPR()"，如果沒有註釋，我們無從知道Clc、Hrly和PR所代表的含義。

// Changed the class name to Employee
public class Employee
{
    public string FirstName { get; set; }

    public decimal CalculateHourlyPay()
    {
        // code to calculate hourly payrate
        return 0m;
    }
}

小結

命名是程式員的基本功，很多程式員顯然沒有完全掌握這個基本功。如果你想成為一個優秀的程式員，良好的命名是必備的素質，它雖然不會體現出你會什麼技術，但它會縱貫你整個編程生涯。
做好編程，從命名開始。