在 C# 6.0 中，Microsoft 引入了一個新的關鍵字
nameof
。
nameof
關鍵字用於獲取變量、型別或成員的名稱，其返回的是一個字串。這一功能在編程時非常有用，特別是當我們需要參照某個變量或成員的名稱時，而不僅僅是值。下面我們將詳細探討
nameof
的用法，並透過範例程式碼來加深理解。
1. 基本用法
nameof
可以用於獲取類名、方法名、內容名、變量名等。這是一個編譯時的操作，所以不會影響執行時的效能。
using System;
public classProgram
{
publicstaticvoidMain()
{
Console.WriteLine(nameof(Program)); // 輸出 "Program"
Console.WriteLine(nameof(Main)); // 輸出 "Main"
}
}
2. 在例外處理和日誌記錄中的使用
nameof
在例外處理和日誌記錄中特別有用，因為它可以幫助我們清晰地指出是哪個變量或方法出了問題。
public classUserService
{
privatestring _userName;
publicstring UserName
{
get { return _userName; }
set
{
if (string.IsNullOrEmpty(value))
{
thrownew ArgumentException("UserName cannot be null or empty.", nameof(UserName));
}
_userName = value;
}
}
}
在這個例子中，如果
UserName
內容被設定為空或 null，程式會丟擲一個
ArgumentException
，並明確指出是哪個內容引起了問題。
3. 在數據繫結和模型驗證中的使用
在數據繫結和模型驗證時，
nameof
也可以派上用場。例如，在使用 MVC 或其他數據繫結框架時，你可能需要指定與某個內容關聯的驗證訊息。
public classUserModel
{
[Required(ErrorMessage = "The " + nameof(UserName) + " field is required.")]
publicstring UserName { get; set; }
}
在這個例子中，
nameof(UserName)
會被替換為 "UserName"，從而生成一條清晰的驗證訊息。
4. 在測試中的使用
在編寫單元測試時，
nameof
可以幫助你清晰地指出正在測試哪個方法或內容。
[TestMethod]
publicvoidTestUserNameProperty()
{
var service = new UserService();
Assert.ThrowsException<ArgumentException>(() => service.UserName = "", "Setting UserName to empty string should throw ArgumentException.");
// 在這裏，我們可以使用 nameof 來清晰地指出我們正在測試 UserName 內容。
}
5. 結論
nameof
是一個強大的工具，它可以幫助我們編寫更清晰、更易於維護的程式碼。透過使用
nameof
，我們可以避免寫死名稱，並使得程式碼在重構時更加健壯。此外，
nameof
還可以提高程式碼的可讀性和可維護性，因為它允許我們直接參照變量、方法或內容的名稱，而不是使用可能容易出錯的字串。
