開發者更新

C#命名規則（對開發者如何理解的工作）

Jacob Mellor，首席技術官 @ Team Iron
Jacob Mellor
Updated: 2026年4月21日

命名慣例 是一套規則和指導方針，開發人員遵循這些規則為變數、方法、類別和其他實體命名，以保持一致性。 一致的命名不僅提高了程式碼的可讀性，還有助於其他開發人員理解和維護您的程式碼。 下面，我們將逐步講解C#命名慣例，專注於實際使用和範例。 讓我們直接深入命名慣例，稍後文章中將討論 IronPDF程式庫。

命名慣例概述

類別和介面

類別名稱應遵循帕斯卡命名法。 這意味著名稱中的每個字首字母大寫，沒有底線或空格。 介面名稱也應遵循帕斯卡命名法，但開頭加上前綴I。 例如：

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

public interface ICustomer
{
    decimal GetBalance();
}

注意類別名稱 Customer 和介面名稱 ICustomer 都遵循帕斯卡命名法。 I 前綴清楚表示 ICustomer 型別為介面。

方法

方法名稱也使用帕斯卡命名法。 每個方法名稱應以大寫字母開頭，隨後的每個字也應以大寫字母開頭。 這是方法定義的一個例子：

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

對於入口點方法，static void Main()，約定相同——使用帕斯卡命名法為方法名稱。

屬性

像方法名稱一樣，屬性名稱也使用帕斯卡命名法。 屬性名稱應明確描述它們所代表的內容：

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

區域變數和方法參數

區域變數和方法參數應使用駝峰命名法。 這意味著第一個字以小寫開頭，後續的字以大寫字母開頭，沒有空格或底線。 這與帕斯卡命名法不同之處在於第一個字母未大寫。

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

在本例中，區域變數 selectedCustomer 遵循駝峰命名法，方法參數 customerName 也是駝峰命名法。

方法參數

方法參數的名稱應具描述性，並遵循駝峰命名法。 這提高了程式碼的可讀性，幫助開發人員理解每個參數代表什麼。

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

靜態成員和欄位

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

靜態欄位

對於靜態欄位，命名慣例是使用駝峰命名法，但加上底線前綴。 這使它們與其他欄位有所不同。

private static int _totalCustomers;

常數

常數通常使用全大寫字母命名，單詞之間用底線分隔，以提高可讀性。 例如：

public const int MAX_CUSTOMERS = 100;

事件處理程式

事件處理程式方法名稱應描述它們處理的事件，通常使用 On 前綴加上事件名稱。 事件處理程式方法的參數通常包括物件 sender 和事件參數。

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

在此情況下，參數被命名為 sender 和 e。 遵循這種命名慣例使您的事件處理程式符合行業標準。

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

私有欄位應遵循駝峰命名法，但加上底線前綴。 這有助於將它們與區域變數和方法參數區分開來。

private string _customerName;

using 物件初始化器 時，您可以在建立類別實例時直接為屬性分配值：

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

在此例子中，屬性名稱 Balance 和 DateOpened 使用帕斯卡命名法，符合屬性的命名慣例。

例外處理與方法

在處理例外時，方法名稱仍然應遵循帕斯卡命名法。 例外類別名稱也應該使用帕斯卡命名法且以Exception結尾。 例如：

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

回傳型別和方法定義

始終確保您的 方法定義具有有意義的名稱和適當的回傳型別。回傳型別應從方法簽名中清楚可見。 這是個例子：

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

在此例子中，方法名稱 CalculateTotalBalance 具有描述性且遵循帕斯卡命名法。

C# 常數的命名慣例

在C#中，常數名稱應全大寫字母，單詞之間用底線分隔。 這讓常數從其他變數中脫穎而出。 這是個例子：

public const double PI = 3.14159;

這種慣例適用於不同型別，確保常數名稱在程式碼中是一致且易於識別的。

C#的行程規範：換行和大括號

C# 也有 編碼慣例 用於 換行 和 大括號。 在C#中，每個開頭的 大括號 { 應與其所屬語句位於同一行，而結尾的 大括號 } 應位於新的一行，與相應的語句對齊。 這是個例子：

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

使用正確的格式使程式碼更易於閱讀和理解。

避免使用匈牙利命名法

在現代C#開發中，不建議使用匈牙利命名法，即變數名稱以資料型別為前綴（例如，字串用strName，整數用intCount）。 相反，使用有意義的名稱來描述變數的用途而非其資料型別：

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

這種方法使程式碼更清晰且更易於維護。

使用IronPDF與命名慣例

C#命名慣例（開發人員如何運作）：圖1 - IronPDF：C# PDF程式庫

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

遵循這些命名慣例，您的程式碼在使用IronPDF生成報告時保持專業、有組織且易於閱讀。

結論

通過遵循這些C#命名慣例，您可以確保您的程式碼乾淨、易讀且易於維護。 無論是在類別名稱中使用帕斯卡命名法、區域變數中使用駝峰命名法，還是在私有欄位中使用底線前綴，這些慣例幫助建立了一致的程式碼庫。

使用IronPDF，您可以跳入並探索其所有功能，並享有免費試用。 這次試用讓您可以親身實驗，看看它如何完美地整合到您的工作流程中。 當您準備好下一步時，授權費用從僅 $999 開始。

Jacob Mellor，首席技術官 @ Team Iron
Jacob Mellor
首席技術官

Jacob Mellor是Iron Software的首席技術官，一位在C# PDF技術上開創先河的遠見工程師。作為Iron Software核心程式碼庫的原開發者，他從創立以來就一直在塑造公司的產品架構，與首席執行官Cameron Rimington一起將公司轉變為服務於NASA、特斯拉和全球政府公司的50多名人員的公司。

閱讀更多

相關文章