C# Nameof (Geliştiriciler İçin Nasıl Çalışır)

Kod Sürdürülebilirliği

'nameof' operatörünün öne çıkan avantajlarından biri, kod sürdürülebilirliği üzerindeki olumlu etkisidir. İsimleri dizi olarak kodlamak yerine, geliştiriciler adların değişmesi durumunda referansların otomatik olarak güncellenmesini sağlayarak 'nameof' kullanabilirler.

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.");
}

Shared Sub 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.")
End Sub

Derleme Zamanı Güvenliği

'nameof', adlardaki yanlış yazım veya tutarsızlık riskini ortadan kaldırarak derleme zamanı güvenliğini artırır. Bir değişken adını yanlış yazmak veya değiştirmek, çalışma zamanı sorunlarını azaltarak bir derleme zamanı hatasına neden olur.

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);
}

Shared Sub Main()
	' Compile-time error if 'myVariable' is misspelled
	Dim myVariable As String
	Dim variableName As String = NameOf(myVariable)

	Console.WriteLine(variableName)
End Sub

Yeniden Adlandırma Desteği

'nameof' operatörü, değişkenler, türler veya üyeleri yeniden adlandırırken sorunsuz bir deneyim sunarak yeniden adlandırma araçlarıyla sorunsuz bir şekilde bütünleşir. Tüm 'nameof' referansları otomatik olarak güncellenir.

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);
}

Shared Sub Main()
	' Before renaming local variable 'myVariable' to 'newVariable'
	Dim myVariableNameChange As String = NameOf(myVariableNameChange)
	' After renaming local variable 'myVariable' to 'newVariable'
	Dim newVariableNameChange As String = NameOf(newVariableNameChange)

	Console.WriteLine(newVariableNameChange)
End Sub

Gelişmiş Hata Ayıklama

Hata ayıklama sırasında, 'nameof' kodu daha bilgilendirici ve okunabilir hale getirir. Günlükleme ifadeler, istisna mesajları ve diğer hata ayıklama çıktıları kısa ve bağlamsal olarak uygun hale gelir.

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.");
}

Shared Sub 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.")
End Sub

Burada, değişken tanımlanmadıysa throw new ArgumentNullException bir istisna fırlatır.

Yansıma

Reflection ile çalışırken, 'nameof' operatörü, türlerin, özelliklerin veya yöntemlerin isimlerini dize olarak kodlamadan almayı basitleştirir.

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

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

Dim type As Type = GetType([MyClass])
Dim typeName As String = NameOf([MyClass])

Örnek sınıf MyClass sabit kodlanmış bir string olabilir, ancak sınıf adını dinamik olarak almak için yansımayı kullanabiliriz. Değişken type sınıf adını içerir ve sonra bir sınıf örneğinin adını almak için nameof anahtar kelimesi kullanılır. Aynı ad değildirler.

Günlükleme ve İstisna İşleme

'nameof', günlükleme ifadeleri ve istisna mesajlarında değerli hale gelir, onları daha okunabilir ve hata oranı düşük hale getirir.

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

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

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

Örnek

Bu örnekte, bir Kişiyi temsil eden basit bir sınıf oluşturacağız ve günlükleme ve hata mesajlarını iyileştirmek için nameof operatörünü kullanacağız.

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();
    }
}

Imports System

Friend Class Person
	Public Property FirstName() As String
	Public Property LastName() As String

	' Method that displays the full name of the person
	Public Sub DisplayFullName()
		If String.IsNullOrEmpty(FirstName) OrElse String.IsNullOrEmpty(LastName) Then
			LogError($"Invalid name: {NameOf(FirstName)} or {NameOf(LastName)} is missing.")
		Else
			Console.WriteLine($"Full Name: {FirstName} {LastName}")
		End If
	End Sub

	' Custom error logging method that highlights errors
	Private Sub LogError(ByVal errorMessage As String)
		Console.ForegroundColor = ConsoleColor.Red
		Console.WriteLine($"Error: {errorMessage}")
		Console.ResetColor()
	End Sub
End Class

Friend Class Program
	Shared Sub Main()
		' Create an instance of the Person class
		Dim person As 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()
	End Sub
End Class

Açıklama

1. Person sınıfımız var ve FirstName ile LastName özelliklerine ve tam adı görüntülemeden önce her iki özelliğin ayarlandığını kontrol eden bir DisplayFullName yöntemine sahibiz.
2. DisplayFullName yönteminin içinde, özellik adlarına dize literalleri olarak başvurmak için nameof(FirstName) ve nameof(LastName) kullanırız. Bu, kod okunabilirliğini artırır ve eğer özellik adları değişirse, hem özellik tanımı hem de karşılık gelen hata mesajı derleme sırasında otomatik olarak güncellenir.
3. LogError yöntemi, hata mesajına özellik adını dinamik olarak eklemek için nameof kullanır.
4. Main yönteminde, Person sınıfının bir örneğini oluşturur, özellikleri ayarlamadan tam adı görüntülemeye çalışır, ardından özellikleri ayarlar ve tam adı tekrar görüntüleriz.

Bu programı çalıştırdığınızda, hata mesajının dinamik olarak özellik adlarını içerdiğini göreceksiniz, daha fazla bağlam sağlar ve hangi özelliğin eksik olduğunu belirlemeyi kolaylaştırır.

Bu örnek, öz debugıktırma adı operatörünün, özellik adları değiştiğinde referansları otomatik olarak güncelleyerek kodun sürdürülebilirliğini geliştirdiğini ve geliştirme sırasında daha bilgilendirici detaylarla hata mesajlarını iyileştirdiğini gösterir.

Lisanslama (Ücretsiz Deneme Mevcuttur)

Lisanslama için Deneme Lisansı Bilgileri'ne bakınız. Bu anahtar appsettings.json içine yerleştirilmesi gereklidir.

"IronPdf.LicenseKey": "your license key"

Deneme lisansı almak için e-posta adresinizi sağlayın.