.NET幫助

C# 屬性（對於開發者的運行原理）

Q: 如何在 C# 中创建自定义特性？

要在 C# 中创建自定义特性，您需要定义一個继承自 System.Attribute 的类。您可以使用 AttributeUsage 特性来指定目標元素，控制自定义特性可以應用的位置。

Jacob Mellor

更新:2026年1月18日

在C#程式設計的世界中，元數據在豐富程式語義和行為方面發揮著至關重要的作用。 C#屬性 作為強大的工具，使開發者能夠將元數據附加到程式中的各種實體，影響編譯器、工具和運行時環境如何解釋和與這些實體互動。

在這本全面的指南中，我們將了解C#屬性，探索它們的語法、應用，及其如何作為一種多功能機制來增強程式的表達性和功能性。

理解C#屬性：入門指南

屬性，以方括號([])表示，是放置在程式碼元素上方的聲明性標籤，提供有關它們的附加資訊。這些附加資訊，也稱為元數據，不會影響程式的核心功能，但會為編譯器、運行時環境和工具提供有價值的見解。

在C#中，對象屬性表示與程式實體（如類或方法）相關的元數據。使用屬性語法定義的屬性實例可增強程式實體的描述，例如使用Conditional("DEBUG")有條件地包含代碼。

以下是使用C#屬性的一個基本示例：

[Serializable]
public class Person
{
    // Class Implementation
}

[Serializable]
public class Person
{
    // Class Implementation
}

$vbLabelText $csharpLabel

在這個例子中，Person類的實例可以被序列化。

C#屬性的類型

屬性應用於C#程式碼中的各種元素，包括：

Assembly：應用於整個程序集，在編譯和執行期間影響其行為。
```
[assembly: AssemblyVersion("1.0.0.0")]
```
```
[assembly: AssemblyVersion("1.0.0.0")]
```
$vbLabelText $csharpLabel
Module：應用於程序集中的模塊，提供有關模塊本身的資訊。
```
[module: SomeCustomModuleAttribute]
```
```
[module: SomeCustomModuleAttribute]
```
$vbLabelText $csharpLabel

Type：應用於類型，影響其行為或提供附加資訊。

[Serializable]
public class Person
{
    // Class Implementation
}

[Serializable]
public class Person
{
    // Class Implementation
}

$vbLabelText $csharpLabel

Method：應用於方法，改變其行為或為工具提供資訊。

[Obsolete("Use the newMethod instead.")]
public void DeprecatedMethod()
{
    // Method implementation
}

[Obsolete("Use the newMethod instead.")]
public void DeprecatedMethod()
{
    // Method implementation
}

$vbLabelText $csharpLabel

Property, Field, Event, etc.：應用於特定類型內的成員，提供與這些成員相關的元數據。

public class Example
{
    [DefaultValue(42)]
    public int Answer { get; set; }
}

public class Example
{
    [DefaultValue(42)]
    public int Answer { get; set; }
}

$vbLabelText $csharpLabel

Creating Custom Attributes in C#

雖然C#提供了許多內置屬性，開發者可以創建自定義屬性來傳達其程式的特定資訊。自定義屬性是通過創建類繼承於System.Attribute來定義的：

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
public class CustomAttribute : Attribute
{
    // Attribute Implementation
}

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
public class CustomAttribute : Attribute
{
    // Attribute Implementation
}

$vbLabelText $csharpLabel

在這個例子中，AllowMultiple屬性指定是否允許在單一目標上多次使用該屬性。在創建自定義屬性類時，會在類名中添加"Attribute"後綴以區分其與常規類。屬性的構造函數將初始化這些屬性，位置參數在向這些屬性傳遞值時發揮作用，提供程式中具有結構化的資訊。

C#屬性的應用

1. 程式碼文檔

屬性在記錄程式碼和提供額外資訊給開發者或工具發揮著重要作用。例如，[Obsolete]屬性表示不再應使用特定元素，開發者應遷移到替代方案。

[Obsolete("This method is obsolete. Use the newMethod instead.")]
public void DeprecatedMethod()
{
    // Method Implementation
}

[Obsolete("This method is obsolete. Use the newMethod instead.")]
public void DeprecatedMethod()
{
    // Method Implementation
}

$vbLabelText $csharpLabel

2. 序列化和持久化

像[Serializable]這樣的屬性告訴運行時環境該類型的實例可以被序列化。這在處理數據持久化等場景時尤為重要。

[Serializable]
public class Person
{
    // Class implementation
}

[Serializable]
public class Person
{
    // Class implementation
}

$vbLabelText $csharpLabel

3. 程式碼分析和工具整合

屬性有助於靜態分析和程式碼生成工具。例如，單元測試框架之類的工具使用像TestMethod這樣的屬性來識別測試方法。

[TestClass]
public class MyTestClass
{
    [TestMethod]
    public void TestMethod()
    {
        // Test method implementation
    }
}

[TestClass]
public class MyTestClass
{
    [TestMethod]
    public void TestMethod()
    {
        // Test method implementation
    }
}

$vbLabelText $csharpLabel

4. ASP.NET MVC路由

在ASP.NET MVC中，屬性廣泛用於路由。 Route屬性允許開發者為操作方法指定路由模板。

[Route("api/[controller]")]
public class SampleController : Controller
{
    [HttpGet]
    [Route("GetSampleData")]
    public IActionResult GetSampleData()
    {
        // Action method implementation
    }
}

[Route("api/[controller]")]
public class SampleController : Controller
{
    [HttpGet]
    [Route("GetSampleData")]
    public IActionResult GetSampleData()
    {
        // Action method implementation
    }
}

$vbLabelText $csharpLabel

簡介IronPDF：簡要概述

IronPDF概述作為為C# .NET Framework開發者量身定制的一個多功能程式庫，提供一套用於PDF生成和操作的廣泛工具。從從HTML創建PDF到從現有文件中提取內容，IronPDF簡化了複雜的任務，是開發者工具包中的寶貴資產。

C#屬性（開發者如何工作）：圖1 - IronPDF網頁

安裝IronPDF：快速入門

要在您的C#專案中開始使用IronPDF程式庫，您可以輕鬆安裝IronPDF的NuGet包。在您的套件管理器控制台中使用以下命令：

Install-Package IronPdf

或者，您可以在NuGet Package Manager中搜尋'IronPDF'並從那裡安裝。

C#屬性：快速概述

C#屬性是提供有关程式中实体的额外信息的聲明性標籤，例如類、方法或屬性。它們讓開發者能夠在不改動程式核心功能的情況下附加元數據或定義行為，如上所述。當我們繼續探索屬性與IronPDF的整合時，我們將發現它們如何為PDF生成提供更細緻的方法。

使用C#屬性增強PDF生成

1. 自定義文件元數據

屬性可用於豐富與PDF文件相關的元數據。 IronPDF允許開發者自定義元數據元素，例如標題、作者和主題。通過使用屬性，您可以將這些資訊動態地注入到生成的PDF中。下面的示例演示了如何使用IronPDF的不同屬性類別：

// Define the DocumentMetadataAttribute
public class DocumentMetadataAttribute : Attribute
{
    public string Title { get; set; }
    public string Author { get; set; }
    public string Subject { get; set; }
}

[DocumentMetadata(Title = "Custom PDF Title", Author = "John Doe", Subject = "Document Subject")]
public class PdfGenerationWithAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new PdfDocument("StyledDocument.pdf");
        // Retrieve DocumentMetadataAttribute using reflection
        var documentMetadata = typeof(PdfGenerationWithAttributes)
            .GetCustomAttributes(typeof(DocumentMetadataAttribute), false)
            .FirstOrDefault() as DocumentMetadataAttribute;
        // Set metadata values
        pdfDocument.MetaData.Title = documentMetadata?.Title;
        pdfDocument.MetaData.Author = documentMetadata?.Author;
        pdfDocument.MetaData.Subject = documentMetadata?.Subject;
        // Perform document generation
        pdfDocument.SaveAs("CustomizedDocument.pdf");
    }
}

// Usage
PdfGenerationWithAttributes obj = new PdfGenerationWithAttributes();
obj.GeneratePdf();

// Define the DocumentMetadataAttribute
public class DocumentMetadataAttribute : Attribute
{
    public string Title { get; set; }
    public string Author { get; set; }
    public string Subject { get; set; }
}

[DocumentMetadata(Title = "Custom PDF Title", Author = "John Doe", Subject = "Document Subject")]
public class PdfGenerationWithAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new PdfDocument("StyledDocument.pdf");
        // Retrieve DocumentMetadataAttribute using reflection
        var documentMetadata = typeof(PdfGenerationWithAttributes)
            .GetCustomAttributes(typeof(DocumentMetadataAttribute), false)
            .FirstOrDefault() as DocumentMetadataAttribute;
        // Set metadata values
        pdfDocument.MetaData.Title = documentMetadata?.Title;
        pdfDocument.MetaData.Author = documentMetadata?.Author;
        pdfDocument.MetaData.Subject = documentMetadata?.Subject;
        // Perform document generation
        pdfDocument.SaveAs("CustomizedDocument.pdf");
    }
}

// Usage
PdfGenerationWithAttributes obj = new PdfGenerationWithAttributes();
obj.GeneratePdf();

$vbLabelText $csharpLabel

在這個例子中，DocumentMetadataAttribute作為一個自定義屬性傳達元數據資訊，允許在PDF生成過程中進行動態自定義。所提供的程式碼定義了一個名為DocumentMetadataAttribute的自定義屬性類於C#中。屬性是向類別、方法或屬性之類的程式實體添加元數據或聲明性信息的一種方式。這些屬性然後通過反射來編輯PDF文件的MetaData。

C#屬性（開發者如何工作）：圖2 - 通過'文件屬性'查看輸出PDF的元數據

2. 使用屬性控制PDF佈局

屬性也可以用於控制PDF文件的佈局。 IronPDF提供選項允許設置頁面大小、邊距和方向。通過使用屬性，您可以基於特定需求來參數化這些佈局設置：

// Define the PageLayoutAttribute
public class PageLayoutAttribute : Attribute
{
    public IronPdf.Rendering.PdfPaperSize Size { get; set; }
    public int MarginTop { get; set; }
    public int MarginBottom { get; set; }
    public int MarginLeft { get; set; }
    public int MarginRight { get; set; }
}

[PageLayout(Size = IronPdf.Rendering.PdfPaperSize.A4, MarginTop = 20, MarginBottom = 20, MarginLeft = 10, MarginRight = 10)]
public class PdfGenerationWithLayoutAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new ChromePdfRenderer();
        // Retrieve PageLayoutAttribute using reflection
        var pageLayout = typeof(PdfGenerationWithLayoutAttributes)
            .GetCustomAttributes(typeof(PageLayoutAttribute), false)
            .FirstOrDefault() as PageLayoutAttribute;
        // Set layout values
        pdfDocument.RenderingOptions.PaperSize = pageLayout?.Size;
        pdfDocument.RenderingOptions.MarginTop = pageLayout?.MarginTop ?? 0;
        pdfDocument.RenderingOptions.MarginBottom = pageLayout?.MarginBottom ?? 0;
        pdfDocument.RenderingOptions.MarginLeft = pageLayout?.MarginLeft ?? 0;
        pdfDocument.RenderingOptions.MarginRight = pageLayout?.MarginRight ?? 0;
        // Perform document generation
        pdfDocument.RenderHtmlAsPdf("<html><body><h1>Hello, IronPDF!</h1></body></html>")
            .SaveAs("CustomLayoutDocument.pdf");
    }
}

// Usage
PdfGenerationWithLayoutAttributes obj = new PdfGenerationWithLayoutAttributes();
obj.GeneratePdf();

// Define the PageLayoutAttribute
public class PageLayoutAttribute : Attribute
{
    public IronPdf.Rendering.PdfPaperSize Size { get; set; }
    public int MarginTop { get; set; }
    public int MarginBottom { get; set; }
    public int MarginLeft { get; set; }
    public int MarginRight { get; set; }
}

[PageLayout(Size = IronPdf.Rendering.PdfPaperSize.A4, MarginTop = 20, MarginBottom = 20, MarginLeft = 10, MarginRight = 10)]
public class PdfGenerationWithLayoutAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new ChromePdfRenderer();
        // Retrieve PageLayoutAttribute using reflection
        var pageLayout = typeof(PdfGenerationWithLayoutAttributes)
            .GetCustomAttributes(typeof(PageLayoutAttribute), false)
            .FirstOrDefault() as PageLayoutAttribute;
        // Set layout values
        pdfDocument.RenderingOptions.PaperSize = pageLayout?.Size;
        pdfDocument.RenderingOptions.MarginTop = pageLayout?.MarginTop ?? 0;
        pdfDocument.RenderingOptions.MarginBottom = pageLayout?.MarginBottom ?? 0;
        pdfDocument.RenderingOptions.MarginLeft = pageLayout?.MarginLeft ?? 0;
        pdfDocument.RenderingOptions.MarginRight = pageLayout?.MarginRight ?? 0;
        // Perform document generation
        pdfDocument.RenderHtmlAsPdf("<html><body><h1>Hello, IronPDF!</h1></body></html>")
            .SaveAs("CustomLayoutDocument.pdf");
    }
}

// Usage
PdfGenerationWithLayoutAttributes obj = new PdfGenerationWithLayoutAttributes();
obj.GeneratePdf();

$vbLabelText $csharpLabel

在這個例子中，PageLayoutAttribute用於封裝頁面佈局設置，允許根據屬性值進行動態調整。

結論

總之，C#屬性作為嵌入元數據在程式代碼中的寶貴機制，影響工具、編譯器和運行時環境如何解釋和處理該程式代碼。無論是利用內置屬性還是創建自定義屬性，開發者都可以利用屬性來增強程式的表達性，實現工具整合，並塑造其應用程式的行為。

C#屬性與IronPDF的整合為更細緻和動態的PDF生成開辟了道路。無論是自定義元數據還是精細調整佈局設置，屬性提供了一種聲明性的方式來增強IronPDF的功能。在探索可能性時，考慮您的PDF生成任務的具體需求以及屬性如何能助您實現更量身定制和有效的過程。

IronPDF在開發時免費使用具有一些限制，您可以通過授權來解鎖完整的IronPDF功能測試。

常見問題解答

什么是 C# 特性及其功能如何？

C# 特性是声明性標签，可用于附加元數据到代碼實体，如类、方法和属性。它们在不改变核心代碼的情况下增強代碼表达性和功能，為编译器、運行時环境和工具提供额外的信息。

如何在 C# 中创建自定义特性？

要在 C# 中创建自定义特性，您需要定义一個继承自 System.Attribute 的类。您可以使用 AttributeUsage 特性来指定目標元素，控制自定义特性可以應用的位置。

特性如何增強 PDF 生成？

特性可用于自定义 PDF 文檔中的元數据，如標题和作者，以及控制頁面大小和边距等布局設置。IronPDF 等庫利用特性能實現動态和定制的 PDF 创建。

[Serializable] 特性在 C# 中用于什么？

[Serializable] 特性用于指示类的實例可以被序列化。这對于數据持久性和流操作很重要，允許對象轉换為易于存储或傳輸的格式。

特性在 ASP.NET MVC 中如何使用？

在 ASP.NET MVC 中，诸如 [Route] 的特性用于定义控制器操作的 URL 路由模板。这有助于创建有组织且可读的 URL 結构，提升應用程序的路由能力。

特性在代碼文檔中扮演什么角色？

诸如 [Obsolete] 的特性起到文檔作用，通過標记不應使用的元素，提出替代方案，并向開發人员提供关于已弃用代碼的警告。

特性如何帮助单元测试？

单元测试框架中，诸如 [TestMethod] 的特性用于识别和执行测试方法。它们提供的元數据被测试工具用来有效地组织和運行测试。

自定义特性的 AllowMultiple 属性有什么重要性？

自定义特性的 AllowMultiple 属性决定了是否可以對单個程序元素應用多個特性實例，提供元數据附加的灵活性。

特性可以用于工具集成嗎？

是的，特性通過提供工具可處理的元數据来促進工具集成。这包括与用于序列化、路由和文檔生成等任务的框架集成。

C# 中有哪些常见的內置特性？

C# 的常见內置特性包括 [Serializable]、[Obsolete]、[Conditional] 和 [TestMethod]。这些特性用于序列化、弃用、條件编译和识别测试方法等各种目的。

Jacob Mellor

立即與工程團隊聊天

首席技術官

Jacob Mellor是Iron Software的首席技術官，也是開創C# PDF技術的前瞻性工程師。作為Iron Software核心代碼庫的原始開發者，他自公司成立以來就塑造了公司的產品架構，並與CEO Cameron Rimington將公司轉型為服務NASA、Tesla以及全球政府機構的50多人公司。

Jacob擁有曼徹斯特大學土木工程一級榮譽學士學位（1998年–2001年）。他於1999年在倫敦開立首家軟體公司，並於2005年建立了他的第一個.NET組件，專注於解決Microsoft生態系統中的複雜問題。

他的旗艦作品IronPDF和Iron Suite .NET程式庫全球已獲得超過3000萬次NuGet安裝，他的基礎代碼不斷在全球各地驅動開發者工具。擁有25年以上的商業經驗和41年的編碼專業知識，Jacob仍然專注於推動企業級C#、Java和Python PDF技術的創新，同時指導下一代技術領導者。

更新2026年2月20日

銜接 CLI 簡化與 .NET : 使用 Curl DotNet 與 IronPDF for .NET

Jacob Mellor 藉由 CurlDotNet 彌補了這方面的不足，CurlDotNet 是為了讓 .NET 生態系統能熟悉 cURL 而建立的函式庫。

更新2025年12月20日

RandomNumberGenerator C#

使用RandomNumberGenerator C#類可以幫助將您的PDF生成和編輯項目提升至新水準

更新2025年12月20日

C#字符串等於（它如何對開發者起作用）

當結合使用強大的PDF庫IronPDF時，開關模式匹配可以讓您構建更智能、更清晰的邏輯來進行文檔處理

C# String.Format（對於開發者的運行原理）

C# 委託（對於開發者的運�...

客戶亮點：

開發者焦點：

網路研討會：

立即開始30天免費試用

C# 屬性（對於開發者的運行原理）

理解C#屬性：入門指南

C#屬性的類型

Creating Custom Attributes in C#

C#屬性的應用

1. 程式碼文檔

2. 序列化和持久化

3. 程式碼分析和工具整合

4. ASP.NET MVC路由

簡介IronPDF：簡要概述

安裝IronPDF：快速入門

C#屬性：快速概述

使用C#屬性增強PDF生成

1. 自定義文件元數據

2. 使用屬性控制PDF佈局

結論

常見問題解答

什么是 C# 特性及其功能如何？

如何在 C# 中创建自定义特性？

特性如何增強 PDF 生成？

[Serializable] 特性在 C# 中用于什么？

特性在 ASP.NET MVC 中如何使用？

特性在代碼文檔中扮演什么角色？

特性如何帮助单元测试？

自定义特性的 AllowMultiple 属性有什么重要性？

特性可以用于工具集成嗎？

C# 中有哪些常见的內置特性？

Iron Support Team

立即開始30天免費試用

C# 屬性（對於開發者的運行原理）

理解C#屬性：入門指南

C#屬性的類型

Creating Custom Attributes in C#

C#屬性的應用

1. 程式碼文檔

2. 序列化和持久化

3. 程式碼分析和工具整合

4. ASP.NET MVC路由

簡介IronPDF：簡要概述

安裝IronPDF：快速入門

C#屬性：快速概述

使用C#屬性增強PDF生成

1. 自定義文件元數據

2. 使用屬性控制PDF佈局

結論

常見問題解答

什么是 C# 特性及其功能如何？

如何在 C# 中创建自定义特性？

特性如何增強 PDF 生成？

[Serializable] 特性在 C# 中用于什么？

特性在 ASP.NET MVC 中如何使用？

特性在代碼文檔中扮演什么角色？

特性如何帮助单元测试？

自定义特性的 AllowMultiple 属性有什么重要性？

特性可以用于工具集成嗎？

C# 中有哪些常见的內置特性？

相關文章

銜接 CLI 簡化與 .NET : 使用 Curl DotNet 與 IronPDF for .NET

RandomNumberGenerator C#

C#字符串等於（它如何對開發者起作用）

下一步：開始30天免費試用

下一步：開始30天免費試用

深受全球數百萬工程師信賴

Iron Support Team