C# Nameof (How It Works For Developers)

程式碼可維護性

nameof "操作符的突出優勢之一是其對程式碼可維護性的正面影響。 開發人員可以使用"nameof"來取代將名稱硬編成字串，以確保名稱變更時引用會自動更新。

static void Main()
{
    // Without using nameof
    Logger.Log("Error: The variable 'myVariable' is null.");
    // Using nameof for improved maintainability
    Logger.Log($"Error: The variable '{nameof(myVariable)}' is null.");
}

static void Main()
{
    // Without using nameof
    Logger.Log("Error: The variable 'myVariable' is null.");
    // Using nameof for improved maintainability
    Logger.Log($"Error: The variable '{nameof(myVariable)}' is null.");
}

編譯時安全性

nameof'可消除名稱中的錯字或不一致的風險，從而增強編譯時的安全性。 變量名稱的任何拼寫錯誤或修改都會觸發編譯時錯誤，減少發生執行時問題的機會。

static void Main()
{
    // Compile-time error if 'myVariable' is misspelled
    string myVariable;
    string variableName = nameof(myVariable);

    Console.WriteLine(variableName);
}

static void Main()
{
    // Compile-time error if 'myVariable' is misspelled
    string myVariable;
    string variableName = nameof(myVariable);

    Console.WriteLine(variableName);
}

重構支援

nameof'運算符號可與重構工具無縫整合，在重新命名變數、類型或成員時提供省事的體驗。 所有 "nameof "引用都會自動更新。

static void Main()
{
    // Before renaming local variable 'myVariable' to 'newVariable'
    string myVariableNameChange = nameof(myVariableNameChange);
    // After renaming local variable 'myVariable' to 'newVariable'
    string newVariableNameChange = nameof(newVariableNameChange);

    Console.WriteLine(newVariableNameChange);
}

static void Main()
{
    // Before renaming local variable 'myVariable' to 'newVariable'
    string myVariableNameChange = nameof(myVariableNameChange);
    // After renaming local variable 'myVariable' to 'newVariable'
    string newVariableNameChange = nameof(newVariableNameChange);

    Console.WriteLine(newVariableNameChange);
}

增強調試

在除錯時，"nameof"可讓程式碼內容更豐富、更易讀。 記錄語句、異常訊息及其他除錯輸出必須變得簡潔且與上下文相關。

static void Main()
{
    // Without using nameof
    // throw new ArgumentNullException("myVariable", "The variable cannot be null."); 
    // Using nameof for improved debugging 
    throw new ArgumentNullException(nameof(myVariable), "The variable cannot be null.");
}

static void Main()
{
    // Without using nameof
    // throw new ArgumentNullException("myVariable", "The variable cannot be null."); 
    // Using nameof for improved debugging 
    throw new ArgumentNullException(nameof(myVariable), "The variable cannot be null.");
}

這裡的 throw new ArgumentNullException 會在變數未被宣告時產生異常。

反饋

在使用反射時，'nameof' 運算符可簡化取得類型、屬性或方法的名稱，而無需使用硬編碼字串。

Type type = typeof(MyClass);
string typeName = nameof(MyClass);

Type type = typeof(MyClass);
string typeName = nameof(MyClass);

範例類別 MyClass 可以是硬式編碼的字串，但我們可以使用反射動態取得類別名稱。 變數 type 具有類別名稱，然後再使用 nameof 關鍵字來取得類別實體的名稱。 它們不是同一個名稱。

記錄與異常處理

在記錄語句和異常訊息時，'nameof' 被證明是非常有價值的，它使這些語句和訊息更具可讀性、更不容易出錯。

Logger.Log($"Error: The property '{nameof(MyClass.MyProperty)}' is out of range.");

Logger.Log($"Error: The property '{nameof(MyClass.MyProperty)}' is out of range.");

範例

在本範例中，我們將建立一個代表 Person 的簡單類別，並使用 nameof 運算子來改善日誌和錯誤訊息。

using System;

class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }

    // Method that displays the full name of the person
    public void DisplayFullName()
    {
        if (string.IsNullOrEmpty(FirstName) || string.IsNullOrEmpty(LastName))
        {
            LogError($"Invalid name: {nameof(FirstName)} or {nameof(LastName)} is missing.");
        }
        else
        {
            Console.WriteLine($"Full Name: {FirstName} {LastName}");
        }
    }

    // Custom error logging method that highlights errors
    private void LogError(string errorMessage)
    {
        Console.ForegroundColor = ConsoleColor.Red;
        Console.WriteLine($"Error: {errorMessage}");
        Console.ResetColor();
    }
}

class Program
{
    static void Main()
    {
        // Create an instance of the Person class
        Person person = new Person();

        // Attempt to display the full name without setting the properties
        person.DisplayFullName();

        // Set the properties and display the full name again
        person.FirstName = "John";
        person.LastName = "Doe";
        person.DisplayFullName();
    }
}

using System;

class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }

    // Method that displays the full name of the person
    public void DisplayFullName()
    {
        if (string.IsNullOrEmpty(FirstName) || string.IsNullOrEmpty(LastName))
        {
            LogError($"Invalid name: {nameof(FirstName)} or {nameof(LastName)} is missing.");
        }
        else
        {
            Console.WriteLine($"Full Name: {FirstName} {LastName}");
        }
    }

    // Custom error logging method that highlights errors
    private void LogError(string errorMessage)
    {
        Console.ForegroundColor = ConsoleColor.Red;
        Console.WriteLine($"Error: {errorMessage}");
        Console.ResetColor();
    }
}

class Program
{
    static void Main()
    {
        // Create an instance of the Person class
        Person person = new Person();

        // Attempt to display the full name without setting the properties
        person.DisplayFullName();

        // Set the properties and display the full name again
        person.FirstName = "John";
        person.LastName = "Doe";
        person.DisplayFullName();
    }
}

說明

1.我們有一個 Person 類，具有 FirstName 和 LastName 屬性，以及一個方法 DisplayFullName 在顯示全名之前，會檢查這兩個屬性是否都已設定。 2.在方法 DisplayFullName 中，我們使用 nameof(FirstName) 和 nameof(LastName) 來以字串字面形式引用屬性名稱。 這可提高程式碼的可讀性，並確保如果屬性名稱改變，屬性定義和對應的錯誤訊息都會在編譯過程中自動更新。 3.方法 LogError 利用 nameof 在錯誤訊息中動態包含屬性名稱。 4.在 Main 方法中，我們建立一個 Person 類的實體，嘗試在未設定屬性的情況下顯示全名，然後再設定屬性並再次顯示全名。

當您執行此程式時，您會發現錯誤訊息動態地加入了屬性名稱，提供了更多的上下文，讓您更容易識別出缺少了哪個屬性。

本範例展示 nameof 運算符如何在屬性名稱變更時自動更新引用，以改善程式碼的可維護性，並在開發過程中以更翔實的詳細資訊增強錯誤訊息。

有關授權，請查看 試用授權資訊。 此 key 需要放在 appsettings.json 中。

"IronPdf.LicenseKey": "your license key"

提供您的電子郵件以取得試用授權。