C# Naming Conventions (How It Works For Developers)

命名慣例概述

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 decimal CalculateInterest(decimal principal, decimal rate)
{
    return principal * rate;
}

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

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

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

本地變數和方法參數

本地變數和方法參數應使用駝峰大小寫。 這表示第一個單字以小楷開頭，接下來的單字以大寫字母開頭，沒有空格或下劃線。 這與 Pascal Case 的不同之處在於首字母不大楷。

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

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

在這個範例中，局部變數 selectedCustomer 遵循駱駝式大小寫慣例，而方法參數 customerName 也是駱駝式大小寫。

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

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

靜態成員與欄位

類中的靜態成員，如 靜態欄位、常量 和 方法，也遵循特定的命名慣例。

private static int _totalCustomers;

private static int _totalCustomers;

public const int MAX_CUSTOMERS = 100;

public const int MAX_CUSTOMERS = 100;

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

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

命名私有欄位和物件初始化器

私人欄位應遵循駱駝紋大小寫慣例，但要有下划線前綴。 這有助於將它們與局部變數和方法參數區分開來。

private string _customerName;

private string _customerName;

使用 物件初始化器時，您可以在建立類別的實體時直接為屬性指定值：

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

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

在這個範例中，屬性名稱 Balance 和 DateOpened 採用 Pascal Case，遵循屬性的慣例。

異常處理與方法

在處理異常時，方法名稱仍應遵循 Pascal Case 慣例。 Exception 類別名稱也應使用 Pascal Case，並以後綴 Exception 結尾。 舉例來說

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

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

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

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

C# 常數的命名慣例

在 C# 中，常數名稱應為全大楷字母，並以下劃線分隔字詞。 這讓常數從其他變數中脫穎而出。 以下是一個範例：

public const double PI = 3.14159;

public const double PI = 3.14159;

此慣例適用於不同類型，可確保 常規名稱在程式碼中一致且易於辨識。

C# 斷行和括號的編碼慣例

C# 也有換行符和括號的編碼慣例。 在 C# 中，每個開頭的 brace { 應該與它所屬的語句在同一行，而結尾的 brace } 應該在新的一行，並與對應的語句對齊。 以下是一個範例：

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

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

使用適當的格式可讓程式碼更容易閱讀和遵循。

避免使用匈牙利語 Notation

在現代 C# 開發中，不鼓勵使用 Hungarian Notation，即變數名稱以資料類型為前綴（例如，strName 表示字串，intCount 表示整數）。 相反，請使用 有意義的名稱，描述變數的用途而非其資料類型：

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

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

此方法可使程式碼更清晰、更易維護。

使用命名慣例的 IronPDF

將 IronPDF 整合至 C# 專案時，必須遵循命名慣例，以維持程式碼的乾淨、可讀性。 IronPDF 可讓您在 C# 應用程式中從 HTML 內容產生 PDF。 在這樣做的同時，必須遵循類別、方法和變數的命名慣例，以維持一致性。 以下是一個簡單實現命名慣例的範例，在遵守這些命名慣例的同時，使用 IronPDF 增強代碼的可讀性：

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

堅持使用這些命名慣例，您的程式碼就能保持專業、有條理，並在使用 IronPDF 生成報告時易於閱讀。

結論

。

只要遵循這些 C# 命名慣例，就能確保您的程式碼乾淨、易讀且容易維護。 無論是使用 Pascal Case 來表示類別名稱、使用 camel case 來表示局部變數，或是使用 underscore 前綴來表示私有欄位，這些慣例都有助於建立一致的程式碼基礎。

有了 IronPdf，您可以透過 免費試用，立即加入並探索其所有功能。 此試用版可讓您進行實驗，親自瞭解它與您的工作流程的整合程度。 當您準備好採取下一步時，授權起始價格僅為 $799 。