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

Adlandırma Kuralları Genel Bakış

public class Customer
{
    public decimal Balance { get; set; }
}

public interface ICustomer
{
    decimal GetBalance();
}

public class Customer
{
    public decimal Balance { get; set; }
}

public interface ICustomer
{
    decimal GetBalance();
}

Public Class Customer
	Public Property Balance() As Decimal
End Class

Public Interface ICustomer
	Function GetBalance() As Decimal
End Interface

public decimal CalculateInterest(decimal principal, decimal rate)
{
    return principal * rate;
}

public decimal CalculateInterest(decimal principal, decimal rate)
{
    return principal * rate;
}

Public Function CalculateInterest(ByVal principal As Decimal, ByVal rate As Decimal) As Decimal
	Return principal * rate
End Function

public DateTime DateOpened { get; set; }
public decimal Reserves { get; set; }

public DateTime DateOpened { get; set; }
public decimal Reserves { get; set; }

Public Property DateOpened() As DateTime
Public Property Reserves() As Decimal

Yerel Değişkenler ve Metod Argümanları

Yerel değişkenler ve metod argümanları camel case kullanmalıdır. Yani, ilk kelime küçük harfle başlar ve sonraki kelimeler büyük harfle başlar, boşluk veya alt tire olmadan. Bu, Pascal Case'den farklı olarak, ilk harfin büyük yazılmadığı anlamına gelir.

public void SelectCustomer(string customerName)
{
    var selectedCustomer = FindCustomer(customerName);
}

public void SelectCustomer(string customerName)
{
    var selectedCustomer = FindCustomer(customerName);
}

Public Sub SelectCustomer(ByVal customerName As String)
	Dim selectedCustomer = FindCustomer(customerName)
End Sub

Bu örnekte, yerel değişken selectedCustomer camel case kuralını takip eder ve metot argümanı customerName da camel case içindedir.

public void AddCustomer(string customerName, DateTime dateOpened)
{
    // Add customer logic
}

public void AddCustomer(string customerName, DateTime dateOpened)
{
    // Add customer logic
}

Public Sub AddCustomer(ByVal customerName As String, ByVal dateOpened As DateTime)
	' Add customer logic
End Sub

Statik Üyeler ve Alanlar

Sınıflardaki statik üyeler, statik alanlar, sabitler ve metodlar, belirli adlandırma kurallarını da takip eder.

private static int _totalCustomers;

private static int _totalCustomers;

Private Shared _totalCustomers As Integer

public const int MAX_CUSTOMERS = 100;

public const int MAX_CUSTOMERS = 100;

Public Const MAX_CUSTOMERS As Integer = 100

private void OnCustomerAdded(object sender, EventArgs e)
{
    // Event handling logic
}

private void OnCustomerAdded(object sender, EventArgs e)
{
    // Event handling logic
}

Private Sub OnCustomerAdded(ByVal sender As Object, ByVal e As EventArgs)
	' Event handling logic
End Sub

Özel Alanları ve Nesne Başlatıcıları Adlandırma

Özel alanlar camel case kuralını, ancak bir alt çizgi önekiyle takip etmelidir. Bu, onları yerel değişkenlerden ve metod argümanlarından ayırt etmeye yardımcı olur.

private string _customerName;

private string _customerName;

Private _customerName As String

Nesne başlatıcıları kullanırken, bir sınıfın örneğini oluştururken doğrudan özelliklere değer atayabilirsiniz:

var seattleCustomer = new Customer
{
    Balance = 1000,
    DateOpened = DateTime.Now
};

var seattleCustomer = new Customer
{
    Balance = 1000,
    DateOpened = DateTime.Now
};

Dim seattleCustomer = New Customer With {
	.Balance = 1000,
	.DateOpened = DateTime.Now
}

Bu örnekte, özellik adları Balance ve DateOpened, özellikler için geçerli olan Pascal Case kuralını takip eder.

Hata Ayıklama ve Metodlar

Hataları ele alırken, metod adları hala Pascal Case kurallarını takip etmelidir. Hata sınıf adları da Pascal Case'e uygun olmalı ve Exception ekiyle bitmelidir. Örneğin:

public void ProcessTransaction()
{
    try
    {
        // Transaction logic
    }
    catch (InvalidOperationException ex)
    {
        // Handle exception
    }
}

public void ProcessTransaction()
{
    try
    {
        // Transaction logic
    }
    catch (InvalidOperationException ex)
    {
        // Handle exception
    }
}

Public Sub ProcessTransaction()
	Try
		' Transaction logic
	Catch ex As InvalidOperationException
		' Handle exception
	End Try
End Sub

public decimal CalculateTotalBalance()
{
    return _totalCustomers * balancePerCustomer;
}

public decimal CalculateTotalBalance()
{
    return _totalCustomers * balancePerCustomer;
}

Public Function CalculateTotalBalance() As Decimal
	Return _totalCustomers * balancePerCustomer
End Function

C# Sabitleri için Adlandırma Kuralları

C#'da sabit adları tamamen büyük harflerle yazılmalı ve kelimeler alt çizgi ile ayrılmalıdır. Bu, sabitleri diğer değişkenlerden ayırt edilir hale getirir. İşte bir örnek:

public const double PI = 3.14159;

public const double PI = 3.14159;

Public Const PI As Double = 3.14159

Bu kural, farklı türlerde geçerli olup sabit adlarının tutarlı ve kodda kolayca tanınabilir olmasını sağlar.

C# Kodlama Kuralları: Satır Sonları ve Parantezler

C# ayrıca satır sonları ve parantezler için de belirli kodlama kuralları içerir. C#'da, her açılış ayraç { ait olduğu ifadeyle aynı satırda olmalı, kapanış ayraç } ise yeni bir satıra geçmeli ve ilgili ifadeyle hizalanmalıdır. İşte bir örnek:

public void AddCustomer(string customerName)
{
    if (!string.IsNullOrEmpty(customerName))
    {
        _customerName = customerName;
    }
}

public void AddCustomer(string customerName)
{
    if (!string.IsNullOrEmpty(customerName))
    {
        _customerName = customerName;
    }
}

Public Sub AddCustomer(ByVal customerName As String)
	If Not String.IsNullOrEmpty(customerName) Then
		_customerName = customerName
	End If
End Sub

Uygun biçimlendirme, kodun daha okunabilir ve takip edilebilir olmasını sağlar.

Macarca Notasyonundan Kaçınma

Modern C# geliştirmede, değişken adlarının veri türleri ile (örneğin, bir dize için strName veya bir tamsayı için intCount) önceden belirlenmesi olan Macarca Notasyonu caydırılmaktadır. Bunun yerine, değişkenin veri türü yerine amacını açıklayan anlamlı adlar kullanın:

public string CustomerName { get; set; }
public int OrderCount { get; set; }

public string CustomerName { get; set; }
public int OrderCount { get; set; }

Public Property CustomerName() As String
Public Property OrderCount() As Integer

Bu yaklaşım, kodun daha anlaşılır ve sürdürülebilir olmasını sağlar.

Adlandırma Kuralları ile IronPDF Kullanımı

IronPDF'i C# projelerinize entegre ederken, adlandırma kurallarını takip ederek temiz ve okunabilir kodu korumak çok önemlidir. IronPDF, C# uygulamalarınızda HTML içeriğinden PDF'ler oluşturmanıza olanak tanır. Bunu yaparken, sınıflarınız, metodlarınız ve değişkenleriniz için adlandırma kurallarını takip etmek önemlidir, böylece tutarlılık sağlanır. İşte, IronPDF'yi kullanarak ve bu adlandırma kurallarına uyarak kodun okunabilirliğini artıran basit bir adlandırma uygulaması örneği:

using IronPdf;

public class PdfReportGenerator
{
    private readonly string _htmlContent;
    private readonly string _filePath;

    public PdfReportGenerator(string htmlContent, string filePath)
    {
        _htmlContent = htmlContent;
        _filePath = filePath;
    }

    public void GenerateReport()
    {
        var pdfRenderer = new ChromePdfRenderer();
        PdfDocument pdfDocument = pdfRenderer.RenderHtmlAsPdf(_htmlContent);
        pdfDocument.SaveAs(_filePath);
    }
}

public static class Program
{
    public static void Main()
    {
        var htmlContent = "<h1>Monthly Report</h1><p>Generated using IronPDF.</p>";
        var filePath = @"C:\Reports\MonthlyReport.pdf";
        PdfReportGenerator reportGenerator = new PdfReportGenerator(htmlContent, filePath);
        reportGenerator.GenerateReport();
    }
}

using IronPdf;

public class PdfReportGenerator
{
    private readonly string _htmlContent;
    private readonly string _filePath;

    public PdfReportGenerator(string htmlContent, string filePath)
    {
        _htmlContent = htmlContent;
        _filePath = filePath;
    }

    public void GenerateReport()
    {
        var pdfRenderer = new ChromePdfRenderer();
        PdfDocument pdfDocument = pdfRenderer.RenderHtmlAsPdf(_htmlContent);
        pdfDocument.SaveAs(_filePath);
    }
}

public static class Program
{
    public static void Main()
    {
        var htmlContent = "<h1>Monthly Report</h1><p>Generated using IronPDF.</p>";
        var filePath = @"C:\Reports\MonthlyReport.pdf";
        PdfReportGenerator reportGenerator = new PdfReportGenerator(htmlContent, filePath);
        reportGenerator.GenerateReport();
    }
}

Imports IronPdf

Public Class PdfReportGenerator
	Private ReadOnly _htmlContent As String
	Private ReadOnly _filePath As String

	Public Sub New(ByVal htmlContent As String, ByVal filePath As String)
		_htmlContent = htmlContent
		_filePath = filePath
	End Sub

	Public Sub GenerateReport()
		Dim pdfRenderer = New ChromePdfRenderer()
		Dim pdfDocument As PdfDocument = pdfRenderer.RenderHtmlAsPdf(_htmlContent)
		pdfDocument.SaveAs(_filePath)
	End Sub
End Class

Public Module Program
	Public Sub Main()
		Dim htmlContent = "<h1>Monthly Report</h1><p>Generated using IronPDF.</p>"
		Dim filePath = "C:\Reports\MonthlyReport.pdf"
		Dim reportGenerator As New PdfReportGenerator(htmlContent, filePath)
		reportGenerator.GenerateReport()
	End Sub
End Module

Bu adlandırma kurallarına bağlı kalarak, IronPDF kullanarak raporlar oluşturduğunuzda kodunuz profesyonel, düzenli ve okunması kolay hale gelir.

Sonuç

Bu C# adlandırma kurallarını takip ederek, kodunuzun temiz, okunabilir ve kolay sürdürülebilir olduğundan emin olabilirsiniz. İster sınıf adları için Pascal Case, yerel değişkenler için camel case kullanın, ister özel alanlar için bir alt çizgi öneki kullanın, bu kurallar tutarlı bir kod tabanı oluşturmanıza yardımcı olur.

IronPDF ile, bir ücretsiz deneme ile tüm yeteneklerini keşfetmeye başlayabilirsiniz. Bu deneme, deneme yapmanıza ve iş akışınıza ne kadar iyi entegre olduğunu kendi gözlerinizle görmenize olanak tanır. Bir sonraki adıma hazır olduğunuzda, lisanslar sadece $799 ile başlar.