.NET 帮助

C# 参考（开发人员如何使用）

Name: IronPDF
Brand: Iron Software
Availability: InStock
Rating: 4.87 (307 reviews)

奇佩戈-卡琳达

2024年四月29日

在C#中，ref关键字是一个强大的功能，它允许方法修改传递引用类型变量的参数值。了解如何使用ref可以提高您在应用程序中管理和操控数据的能力。

本文将引导您了解ref关键字的基础知识、其应用以及与不同数据类型一起使用时的细微差别。我们还将学习关于IronPDF library for .NET，这是一个PDF库。

了解 ref 参数

一个ref参数是一种方法参数，作为传递给方法的变量的引用。与只传递变量副本的标准值参数不同，ref 参数允许被调用的方法修改原始变量的值。当您需要一个方法来更新传递给它的变量的状态时，这种行为至关重要。

考虑以下示例来演示 ref 的基本用法，重点说明引用类型变量在整个方法调用中如何在同一对象中保留其参数值：

class Program
{
    static void Main()
    {
        int number = 100;
        ModifyNumber(ref number);
        Console.WriteLine(number);
    }
    static void ModifyNumber(ref int number)
    {
        number = 200;
    }
}

class Program
{
    static void Main()
    {
        int number = 100;
        ModifyNumber(ref number);
        Console.WriteLine(number);
    }
    static void ModifyNumber(ref int number)
    {
        number = 200;
    }
}

Friend Class Program
	Shared Sub Main()
		Dim number As Integer = 100
		ModifyNumber(number)
		Console.WriteLine(number)
	End Sub
	Private Shared Sub ModifyNumber(ByRef number As Integer)
		number = 200
	End Sub
End Class

$vbLabelText $csharpLabel

在此示例中，Main 方法声明了一个整数 number 并将其初始化为 100。然后调用 ModifyNumber，并将 number 作为 ref 参数传递。在 ModifyNumber 中，number 的值被更改为 200。由于 number 是通过引用传递的，因此更改会反映在 Main 方法的原始值中，并且 200 会被打印到控制台。

参考参数的工作原理

当您使用ref关键字声明方法参数时，您是在告诉编译器该参数将引用原始变量而不是副本。这可以通过传递变量的内存地址而不是实际值来实现。被调用方法和调用方法都访问同一内存位置，这意味着对参数所做的任何更改都会直接作用于原始变量。

理解ref的关键是认识到它既可以用于值类型，也可以用于引用类型。值类型包括整数和结构等简单数据类型，而引用类型包括对象和数组。然而，即使引用类型变量本质上存储内存地址，使用ref与引用类型可以让你修改实际的引用，而不仅仅是对象的内容。

ref 和 out 之间的差异

虽然ref和out关键字都允许修改原始变量，但二者之间存在重要区别。一个output参数在传递给方法之前不需要初始化。相反，ref 参数要求在传递之前对变量进行初始化。此外，使用out 参数的方法必须在方法返回之前分配一个值。此要求不适用于ref参数。

以下是您可能使用out关键字的方法：

class Program
{
    static void Main()
    {
        int result;
        CalculateResult(out result);
        Console.WriteLine(result);
    }
    static void CalculateResult(out int calculation)
    {
        calculation = 20 * 5;
    }
}

class Program
{
    static void Main()
    {
        int result;
        CalculateResult(out result);
        Console.WriteLine(result);
    }
    static void CalculateResult(out int calculation)
    {
        calculation = 20 * 5;
    }
}

Friend Class Program
	Shared Sub Main()
		Dim result As Integer = Nothing
		CalculateResult(result)
		Console.WriteLine(result)
	End Sub
	Private Shared Sub CalculateResult(ByRef calculation As Integer)
		calculation = 20 * 5
	End Sub
End Class

$vbLabelText $csharpLabel

在这种情况下，CalculateResult 在方法中初始化计算，而Main反映了结果。

方法重载中 ref 的实际使用

ref 还可以用于方法重载，其中方法签名通过 ref 关键字进行更改。方法签名由方法名及其参数类型组成，包括参数是通过引用（ref）、按值传递，还是作为out参数传递。

考虑根据ref和值参数重载方法：

class Program
{
    static void Main()
    {
        int normalParameter = 10, refParameter = 10;
        IncrementValue(normalParameter);
        IncrementValue(ref refParameter);
        Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}");
    }
    static void IncrementValue(int number)
    {
        number++;
    }
    static void IncrementValue(ref int number)
    {
        number++;
    }
}

class Program
{
    static void Main()
    {
        int normalParameter = 10, refParameter = 10;
        IncrementValue(normalParameter);
        IncrementValue(ref refParameter);
        Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}");
    }
    static void IncrementValue(int number)
    {
        number++;
    }
    static void IncrementValue(ref int number)
    {
        number++;
    }
}

Friend Class Program
	Shared Sub Main()
		Dim normalParameter As Integer = 10, refParameter As Integer = 10
		IncrementValue(normalParameter)
		IncrementValue(refParameter)
		Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}")
	End Sub
'INSTANT VB TODO TASK: VB does not allow method overloads which differ only in parameter ByVal/ByRef:
'ORIGINAL LINE: static void IncrementValue(int number)
	Private Shared Sub IncrementValue(ByVal number As Integer)
		number += 1
	End Sub
'INSTANT VB TODO TASK: VB does not allow method overloads which differ only in parameter ByVal/ByRef:
'ORIGINAL LINE: static void IncrementValue(ref int number)
	Private Shared Sub IncrementValue(ByRef number As Integer)
		number += 1
	End Sub
End Class

$vbLabelText $csharpLabel

在这里，IncrementValue 被重载，其中一个版本接受普通参数，一个版本接受ref参数。 ref 版本会增加原始变量，而普通版本只改变副本。

IronPDF 简介

C# Ref（对开发者的作用）：图1

IronPDF for .NET PDF Solutions 是一个全面的 .NET 库，旨在处理 PDF 文档。它主要用 C# 构建，重点在于简化从HTML 内容创建和操作 PDF。通过采用 Chrome 渲染引擎，IronPDF 可提供高质量、像素完美的 PDF 文档，捕捉 HTML、CSS、JavaScript 和图像内容的细微差别。

该库用途广泛，支持包括 .NET Framework、.NET Core 和 .NET Standard 在内的各种 .NET 环境，因此适用于从桌面系统到网络系统的各种应用。 IronPDF 不仅支持 PDF 创建，还提供编辑、保护和将 PDF 转换为其他格式的功能。

这种能力扩展到提取文本和图像、填写表格，甚至应用数字签名，确保在 .NET 应用程序中全面处理 PDF 文档。

将 IronPdf 与 C# 和 ref 关键字整合在一起

IronPDF可以与C#集成，以利用该语言的强大功能，包括使用ref关键字按引用传递参数。这种集成允许动态生成 PDF，其内容可能取决于运行时确定值的变量。

为了说明使用ref关键字将IronPDF与C#集成的过程，可以考虑这样一种情况：我们希望生成一份包含动态计算值的PDF报告。这个值将在一个接受ref参数的方法中计算，该方法允许修改该值，然后在生成的PDF中反映出来。

代码示例：使用 ref 生成具有动态内容的 PDF

以下 C# 代码演示了如何结合 ref 关键字使用 IronPDF 生成 PDF 文档。该代码计算一个值，通过一个接受ref参数的方法对其进行修改，然后使用IronPDF生成包含此动态内容的PDF。

using IronPdf;
using System;
class Program
{
    static void Main(string [] args)
    {
        License.LicenseKey = "License-Key";
        // Initialize the value
        int totalSales = 150;
        // Modify the value within the method using 'ref'
        AddMonthlyBonus(ref totalSales);
        // Use IronPDF to generate a PDF report
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>");
        // Save the PDF to a file
        PDF.SaveAs("MonthlySalesReport.pdf");
        // Confirm the PDF has been generated
        Console.WriteLine("PDF generated successfully. Check your project directory.");
    }
    static void AddMonthlyBonus(ref int sales)
    {
        // Assume a bonus of 10% of the sales
        sales += (int)(sales * 0.1);
    }
}

using IronPdf;
using System;
class Program
{
    static void Main(string [] args)
    {
        License.LicenseKey = "License-Key";
        // Initialize the value
        int totalSales = 150;
        // Modify the value within the method using 'ref'
        AddMonthlyBonus(ref totalSales);
        // Use IronPDF to generate a PDF report
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>");
        // Save the PDF to a file
        PDF.SaveAs("MonthlySalesReport.pdf");
        // Confirm the PDF has been generated
        Console.WriteLine("PDF generated successfully. Check your project directory.");
    }
    static void AddMonthlyBonus(ref int sales)
    {
        // Assume a bonus of 10% of the sales
        sales += (int)(sales * 0.1);
    }
}

Imports IronPdf
Imports System
Friend Class Program
	Shared Sub Main(ByVal args() As String)
		License.LicenseKey = "License-Key"
		' Initialize the value
		Dim totalSales As Integer = 150
		' Modify the value within the method using 'ref'
		AddMonthlyBonus(totalSales)
		' Use IronPDF to generate a PDF report
		Dim Renderer = New ChromePdfRenderer()
		Dim PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>")
		' Save the PDF to a file
		PDF.SaveAs("MonthlySalesReport.pdf")
		' Confirm the PDF has been generated
		Console.WriteLine("PDF generated successfully. Check your project directory.")
	End Sub
	Private Shared Sub AddMonthlyBonus(ByRef sales As Integer)
		' Assume a bonus of 10% of the sales
		sales += CInt(Math.Truncate(sales * 0.1))
	End Sub
End Class

$vbLabelText $csharpLabel

C# 引用（开发人员如何使用）：图2

在这个示例中，totalSales 从 150 开始。AddMonthlyBonus 方法使用 ref 关键字通过引用获取该值，计算 10% 的奖金，并将其添加到原始销售额中。然后，IronPdf 会生成一个包含 HTML 代码段的 PDF 文档，报告包括奖金在内的总销售额。最终文档保存为 "MonthlySalesReport.pdf"。

结论

C# Ref（开发人员如何使用）：图 3

理解C#中的ref关键字为管理方法之间数据传递提供了一个有价值的工具。通过允许方法直接修改传递给它们的参数的原始值，ref 可以使您的方法更加灵活和强大。

随着您对ref的经验积累，您将更好地理解何时以及如何有效地使用它来满足您的编程需求。 IronPDF 提供免费试用以开始使用 PDF 功能，价格从$749起。

奇佩戈-卡琳达

立即与工程团队聊天

软件工程师

Chipego 拥有出色的倾听技巧，这帮助他理解客户问题并提供智能解决方案。他在 2023 年加入 Iron Software 团队，此前他获得了信息技术学士学位。IronPDF 和 IronOCR 是 Chipego 主要专注的两个产品，但他对所有产品的了解每天都在增长，因为他不断找到支持客户的新方法。他喜欢 Iron Software 的合作氛围，公司各地的团队成员贡献他们丰富的经验，以提供有效的创新解决方案。当 Chipego 离开办公桌时，你经常可以发现他在看书或踢足球。

< 前一页
MS Graph .NET（开发人员如何使用）

下一步 >
Mudblazor .NET 8（对开发人员的工作方式）