.NET 幫助

C# 參數（它是如何為開發人員工作的）

發佈 2024年3月26日

在 C# 中，params 關鍵字是 .NET 的一項強大功能，允許方法接受可變數量的參數。這可以顯著簡化調用需要可變數量參數的方法時的語法。在這本綜合指南中，我們將探討 C# 中的 params 關鍵字，其語法、使用案例和最佳實踐。稍後在本文中，我們將介紹IronPDF圖書館由Iron Software並解釋如何使用參數關鍵字和 IronPDF 來生成 PDF。

C# Params 參數類型是什麼？

在 C# 的領域中，方法通常遵循一套預定的參數。然而，在某些情況下，人們可能會不確定一個方法預期的參數確切數量。輸入 "params" 關鍵字，一種可以指定方法參數並能夠容納多個參數陣列的解決方案。當開發人員事先不確定確切的參數數量時，這項功能顯得極其有用，這使得在方法宣告中可以傳遞不確定或可選數量的參數，所有參數類型均相同。

public class ParamsExample
{
    public void PrintMessages(params string [] messages)
    {
        foreach (var message in messages)
        {
            Console.WriteLine(message);
        }
    }
}
// Usage
class Program {
public static void main(){
var example = new ParamsExample();
example.PrintMessages("Hello", "World", "!");
}
// more examples
public static void AddItemsToShoppingBasket(params string [] items)
{
  // ....
}
public static void AddItemsSumToShoppingBasket(params int [] sum) // params int
{
  // ....
}

public class ParamsExample
{
    public void PrintMessages(params string [] messages)
    {
        foreach (var message in messages)
        {
            Console.WriteLine(message);
        }
    }
}
// Usage
class Program {
public static void main(){
var example = new ParamsExample();
example.PrintMessages("Hello", "World", "!");
}
// more examples
public static void AddItemsToShoppingBasket(params string [] items)
{
  // ....
}
public static void AddItemsSumToShoppingBasket(params int [] sum) // params int
{
  // ....
}

Public Class ParamsExample
	Public Sub PrintMessages(ParamArray ByVal messages() As String)
		For Each message In messages
			Console.WriteLine(message)
		Next message
	End Sub
End Class
' Usage
Friend Class Program
Public Shared Sub main()
Dim example = New ParamsExample()
example.PrintMessages("Hello", "World", "!")
End Sub
' more examples
Public Shared Sub AddItemsToShoppingBasket(ParamArray ByVal items() As String)
  ' ....
End Sub
Public Shared Sub AddItemsSumToShoppingBasket(ParamArray ByVal sum() As Integer) ' params int
  ' ....
End Sub

VB C#

"AddItemsToShoppingBasket" 方法可以用可變數量的字串參數作為引數來調用。 params 物件關鍵字透過允許開發人員直接傳遞選擇性參數，而不需要顯式地創建陣列輸入，簡化了方法呼叫的語法。

class Program {
AddItemsToShoppingBasket("cake", "pizza", "cold drink");
AddItemsToShoppingBasket("snacks", "burger");
AddItemsToShoppingBasket(); // Valid with zero parameters default value
}

class Program {
AddItemsToShoppingBasket("cake", "pizza", "cold drink");
AddItemsToShoppingBasket("snacks", "burger");
AddItemsToShoppingBasket(); // Valid with zero parameters default value
}

Friend Class Program
AddItemsToShoppingBasket("cake", "pizza", "cold drink")
AddItemsToShoppingBasket("snacks", "burger")
AddItemsToShoppingBasket() ' Valid with zero parameters default value
End Class

VB C#

考量和最佳實踐

將參數放在參數列表末尾：建議的做法是將參數放在方法參數列表的末尾。此做法有助於提高清晰度，減少在方法調用時的混淆。需要顯式值的參數應在參數之前，以達到有效的組織。

顯式指定非參數參數：在調用帶有參數的方法時，確保為非參數參數明確提供值。此作法避免了歧義，並保證以所需參數的數目準確地調用該方法。

謹慎小心以防止模糊性：在使用多個重載或相同類型的參數的方法時，謹慎是關鍵。編譯器可能會努力確定要調用的適當方法，可能導致模糊錯誤。

探索替代方法：雖然參數提供了便利，但在某些情況下可以考慮其他方法。利用集合，例如 List可能更適合增強功能或當傳遞命名參數符合您的目標時。

謹慎應用於相關場景：在參數數量可變且可能在不同方法調用中波動的場景下，謹慎部署參數。將其用於參數數量不可預測的情況，避免在參數數量固定且已知時使用。

參數類型的一維陣列

AddItemsToShoppingBasket 也可以通過調用一維數組來使用。

// example
class Program {
public static void main()
{
var items = [] {"cold drink", "snack", "roll", }; // 1D string array
AddItemsToShoppingBasket(items); // works
AddItemsToShoppingBasket( "cold drink", "coke", "roll",); // same as above line
}
}

// example
class Program {
public static void main()
{
var items = [] {"cold drink", "snack", "roll", }; // 1D string array
AddItemsToShoppingBasket(items); // works
AddItemsToShoppingBasket( "cold drink", "coke", "roll",); // same as above line
}
}

' example
Friend Class Program
Public Shared Sub main()
Dim items = () {"cold drink", "snack", "roll"} ' 1D string array
AddItemsToShoppingBasket(items) ' works
AddItemsToShoppingBasket("cold drink", "coke", "roll",) ' same as above line
End Sub
End Class

VB C#

傳遞一個相同類型的參數逗號分隔數組

AddItemsToShoppingBasket 也可以通過在方法調用中傳遞變量列表/數組來調用，如下所示。

// example method signature
class Program {
AddItemsToShoppingBasket("snacks", "burger", "snacks", "burger", "cold drink"); // comma separated values
AddItemsToShoppingBasket("snacks"); 
}

// example method signature
class Program {
AddItemsToShoppingBasket("snacks", "burger", "snacks", "burger", "cold drink"); // comma separated values
AddItemsToShoppingBasket("snacks"); 
}

' example method signature
Friend Class Program
AddItemsToShoppingBasket("snacks", "burger", "snacks", "burger", "cold drink") ' comma separated values
AddItemsToShoppingBasket("snacks")
End Class

VB C#

傳遞一個定義類型的陣列

陣列應該包含在參數方法中定義的相同類型，否則會拋出如下錯誤。

// example
AddItemsToShoppingBasket("snacks",2,"burger"); // error 
AddItemsToShoppingBasket(2,3,4); // error as params type is string

// example
AddItemsToShoppingBasket("snacks",2,"burger"); // error 
AddItemsToShoppingBasket(2,3,4); // error as params type is string

' example
AddItemsToShoppingBasket("snacks",2,"burger") ' error
AddItemsToShoppingBasket(2,3,4) ' error as params type is string

VB C#

由於方法中定義的參數類型不匹配，發生語法錯誤。

總是方法中的最後一個參數

在方法簽名宣告中，params 參數之後不允許有其他參數，且在方法參數宣告中僅允許一個 params 引數。

方法簽名應在最後定義參數，之後不允許有任何參數。如此定義會導致編譯錯誤。

class program {
static void Main(string [] args){
// example 1
   public static void AddItemsToShoppingBasket(double total, params string [] items)
   {
     // ....
   } // This works
}
}
example 2
static void Main(string [] args){
   public static void AddItemsToShoppingBasket(double total, int total, params string [] items)
   {
     // ....
   } // This works
}
// example 3 error scenario
static void Main(string [] args){
   public static void AddItemsToShoppingBasket(params string [] items, decimal total, int total)
   {
     // error
   } // params keyword is defined as first parameter, needs to be at the last.
}

class program {
static void Main(string [] args){
// example 1
   public static void AddItemsToShoppingBasket(double total, params string [] items)
   {
     // ....
   } // This works
}
}
example 2
static void Main(string [] args){
   public static void AddItemsToShoppingBasket(double total, int total, params string [] items)
   {
     // ....
   } // This works
}
// example 3 error scenario
static void Main(string [] args){
   public static void AddItemsToShoppingBasket(params string [] items, decimal total, int total)
   {
     // error
   } // params keyword is defined as first parameter, needs to be at the last.
}

Friend Class program
Shared Sub Main(ByVal args() As String)
' example 1
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'   public static void AddItemsToShoppingBasket(double total, params string [] items)
'   {
'	 ' ....
'   } ' This works
End Sub
End Class
example 2 Shared Sub Main(ByVal args() As String)
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'   public static void AddItemsToShoppingBasket(double total, int total, params string [] items)
'   {
'	 ' ....
'   } ' This works
End Sub
' example 3 error scenario
Shared Sub Main(ByVal args() As String)
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'   public static void AddItemsToShoppingBasket(params string [] items, decimal total, int total)
'   {
'	 ' error
'   } ' params keyword is defined as first parameter, needs to be at the last.
End Sub

VB C#

只有一個參數關鍵字

在方法簽名中僅允許一個參數參數。如果在方法簽名中找到多個 params 關鍵字，編譯器將引發錯誤。

//only one params keyword example
class Program {
static void Main(string [] args){
public static void AddItemsToShoppingBasket(params string [] items, params string [] quantity)
{
} // Compiler error, This does not work. 
}
}

//only one params keyword example
class Program {
static void Main(string [] args){
public static void AddItemsToShoppingBasket(params string [] items, params string [] quantity)
{
} // Compiler error, This does not work. 
}
}

'only one params keyword example
Friend Class Program
Shared Sub Main(ByVal args() As String)
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'public static void AddItemsToShoppingBasket(params string [] items, params string [] quantity)
'{
'} ' Compiler error, This does not work.
End Sub
End Class

VB C#

您可以不傳遞任何參數

如果一個方法只有以 params 關鍵字宣告的參數，那麼它可以像下面這樣不帶任何引數地被調用，而編譯器不會拋出錯誤。

AddItemsToShoppingBasket(); // Works

AddItemsToShoppingBasket(); // Works

AddItemsToShoppingBasket() ' Works

VB C#

任何帶有參數的參數被視為可選參數，可以在不傳遞參數的情況下調用。

範例程式碼

創建一個新的主控台應用程式。打開 Visual Studio，創建新項目並選擇控制台應用程式類型。

C# 參數（針對開發人員的工作原理）：圖 1 - 創建一個新的控制台應用程序

現在添加以下代碼。

class Program {
Console.WriteLine("Params demo");
List<string> cart = new List<string>();
void AddItemsToShoppingBasket(params string [] samples)
{
    for (int i = 0; i < samples.Length; i++)
    {
        cart.Add(samples [i]);
    }
}
// caller code
static void Main(string [] args) {
Console.WriteLine("Enter the cart items as comma separated values");
var itemsString = Console.ReadLine();
if (itemsString != null)
{
    var items = itemsString.Split(",").ToArray();
    AddItemsToShoppingBasket(items);
}
AddItemsToShoppingBasket("Sample1", "Sample2");
Console.WriteLine("-------------------------------------------------------");
Console.WriteLine("Display Cart");
foreach (var item in cart)
{
    Console.WriteLine(item);
}
}
}

class Program {
Console.WriteLine("Params demo");
List<string> cart = new List<string>();
void AddItemsToShoppingBasket(params string [] samples)
{
    for (int i = 0; i < samples.Length; i++)
    {
        cart.Add(samples [i]);
    }
}
// caller code
static void Main(string [] args) {
Console.WriteLine("Enter the cart items as comma separated values");
var itemsString = Console.ReadLine();
if (itemsString != null)
{
    var items = itemsString.Split(",").ToArray();
    AddItemsToShoppingBasket(items);
}
AddItemsToShoppingBasket("Sample1", "Sample2");
Console.WriteLine("-------------------------------------------------------");
Console.WriteLine("Display Cart");
foreach (var item in cart)
{
    Console.WriteLine(item);
}
}
}

Friend Class Program
Console.WriteLine("Params demo")
Dim cart As New List(Of String)()
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'void AddItemsToShoppingBasket(params string [] samples)
'{
'	for (int i = 0; i < samples.Length; i++)
'	{
'		cart.Add(samples [i]);
'	}
'}
' caller code
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'static void Main(string [] args)
'{
'Console.WriteLine("Enter the cart items as comma separated values");
'var itemsString = Console.ReadLine();
'if (itemsString != Nothing)
'{
'	var items = itemsString.Split(",").ToArray();
'	AddItemsToShoppingBasket(items);
'}
'AddItemsToShoppingBasket("Sample1", "Sample2");
'Console.WriteLine("-------------------------------------------------------");
'Console.WriteLine("Display Cart");
'foreach (var item in cart)
'{
'	Console.WriteLine(item);
'}
'}
End Class

VB C#

輸出

C# 參數（開發者如何使用）：圖 2 - 上述代碼輸出

介紹 IronPDF

IronPDF C# PDF library 是一個功能強大的程式庫，來自 Iron Software，它可以在 C# 中讀取、編寫和管理 PDF 文件。它支持所有現代應用程式開發類型，如行動裝置、網站、桌面、Docker 等。並且支持不同的作業系統，如 Windows、Linux、Unix 等。它不依賴於本地作業系統的方法。

安裝

IronPDF 程式庫可以使用以下方式安裝NuGet在封裝管理員主控台使用以下命令或使用 Visual Studio 封裝管理員。

dotnet add package IronPdf

dotnet add package IronPdf

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'dotnet add package IronPdf

VB C#

使用 IronPDF 生成 PDF

現在我們將使用IronPDF從上述範例生成PDF文件。

class program
{
public static void main()
{
Console.WriteLine("IronPDF to generate the PDF document for Params Example");
List<string> cart = new List<string>();
void AddItemsToShoppingBasket(params string [] items)
{
    for (int i = 0; i < items.Length; i++)
    {
        cart.Add(items [i]);
    }
}
// take input from console
Console.WriteLine("Enter the cart items as comma seperated values");
var itemsString = Console.ReadLine();
// read the items
if (itemsString != null)
{
    var items = itemsString.Split(",").ToArray();
    AddItemsToShoppingBasket(items);
}
// add to cart
AddItemsToShoppingBasket("Sample1", "Sample2");
Console.WriteLine("------------------------------------------------");
Console.WriteLine("Display Cart");
Console.WriteLine("------------------------------------------------");
string name = "Sam";
var count = cart.Count;
string content = $@"<!DOCTYPE html>
<html>
<body>
<h1>Hello, {name}!</h1>
<p>You have {count} items in the cart.</p>
" +
string.Join("\n", cart.Select(x => $"<p>{x}</p>"))
+ @"
</body>
</html>";
// Create a new PDF document
var pdfDoc = new ChromePdfRenderer();
pdfDoc.RenderHtmlAsPdf(content).SaveAs("cart.pdf");
}
}

class program
{
public static void main()
{
Console.WriteLine("IronPDF to generate the PDF document for Params Example");
List<string> cart = new List<string>();
void AddItemsToShoppingBasket(params string [] items)
{
    for (int i = 0; i < items.Length; i++)
    {
        cart.Add(items [i]);
    }
}
// take input from console
Console.WriteLine("Enter the cart items as comma seperated values");
var itemsString = Console.ReadLine();
// read the items
if (itemsString != null)
{
    var items = itemsString.Split(",").ToArray();
    AddItemsToShoppingBasket(items);
}
// add to cart
AddItemsToShoppingBasket("Sample1", "Sample2");
Console.WriteLine("------------------------------------------------");
Console.WriteLine("Display Cart");
Console.WriteLine("------------------------------------------------");
string name = "Sam";
var count = cart.Count;
string content = $@"<!DOCTYPE html>
<html>
<body>
<h1>Hello, {name}!</h1>
<p>You have {count} items in the cart.</p>
" +
string.Join("\n", cart.Select(x => $"<p>{x}</p>"))
+ @"
</body>
</html>";
// Create a new PDF document
var pdfDoc = new ChromePdfRenderer();
pdfDoc.RenderHtmlAsPdf(content).SaveAs("cart.pdf");
}
}

Imports Microsoft.VisualBasic

Friend Class program
Public Shared Sub main()
Console.WriteLine("IronPDF to generate the PDF document for Params Example")
Dim cart As New List(Of String)()
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'void AddItemsToShoppingBasket(params string [] items)
'{
'	for (int i = 0; i < items.Length; i++)
'	{
'		cart.Add(items [i]);
'	}
'}
' take input from console
Console.WriteLine("Enter the cart items as comma seperated values")
Dim itemsString = Console.ReadLine()
' read the items
If itemsString IsNot Nothing Then
	Dim items = itemsString.Split(",").ToArray()
	AddItemsToShoppingBasket(items)
End If
' add to cart
AddItemsToShoppingBasket("Sample1", "Sample2")
Console.WriteLine("------------------------------------------------")
Console.WriteLine("Display Cart")
Console.WriteLine("------------------------------------------------")
Dim name As String = "Sam"
Dim count = cart.Count
Dim content As String = $"<!DOCTYPE html>
<html>
<body>
<h1>Hello, {name}!</h1>
<p>You have {count} items in the cart.</p>
" & String.Join(vbLf, cart.Select(Function(x) $"<p>{x}</p>")) & "
</body>
</html>"
' Create a new PDF document
Dim pdfDoc = New ChromePdfRenderer()
pdfDoc.RenderHtmlAsPdf(content).SaveAs("cart.pdf")
End Sub
End Class

VB C#

在上面的程式碼中，我們正在為購物車項目生成HTML文件，然後將其保存為PDF文件，使用IronPDF.

輸出

C# 參數（開發人員如何使用）：圖 3 - 上述程式碼的 PDF 輸出

授權（免費試用可用）

IronPDF 需要授權金鑰才能在生產環境中運作。可以從授權頁面獲取試用密鑰這裡. 將密鑰放置在 appsettings.json 中。

"IronPdf.LicenseKey": "your license key"

"IronPdf.LicenseKey": "your license key"

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'"IronPdf.LicenseKey": "your license key"

VB C#

請提供您的電子郵件地址以獲取試用許可證，該許可證將發送到您的電子郵件地址。

結論

在 C# 使用 .NET 8 中的 params 關鍵字提供了一種靈活的方法來處理需要可變數量參數的方法。它簡化了方法調用並使程式碼更具可讀性和可維護性。一起與IronPDF，這對於任何程式設計師來說都是撰寫乾淨程式碼的絕佳技能組合。

< 上一頁
C# PostgreSQL（如何為開發人員運作）

下一個 >
C# 列舉 (開發人員如何使用)

報告問題

加入我們的漏洞獎勵計劃以獲得 Iron Swag

準備開始了嗎？版本: 2024.12 剛剛發布

查看許可證 >

C# 參數（它是如何為開發人員工作的）

C# Params 參數類型是什麼？

考量和最佳實踐

參數類型的一維陣列

傳遞一個相同類型的參數逗號分隔數組

傳遞一個定義類型的陣列

總是方法中的最後一個參數

只有一個參數關鍵字

您可以不傳遞任何參數

範例程式碼

輸出

介紹 IronPDF

安裝

使用 IronPDF 生成 PDF

輸出

授權（免費試用可用）

結論

本頁內容

報告問題

準備開始了嗎？版本: 2024.12 剛剛發布

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號立即。

試用表格已提交
成功地.

受到全球數百萬工程師的信任

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號立即。

受到全球數百萬工程師的信任

IronPDF 是 IRON 的一部分套件

C# 參數（它是如何為開發人員工作的）

C# Params 參數類型是什麼？

考量和最佳實踐

參數類型的一維陣列

傳遞一個相同類型的參數逗號分隔數組

傳遞一個定義類型的陣列

總是方法中的最後一個參數

只有一個參數關鍵字

您可以不傳遞任何參數

範例程式碼

輸出

介紹 IronPDF

安裝

使用 IronPDF 生成 PDF

輸出

授權（免費試用可用）

結論

本頁內容

報告問題

準備開始了嗎？ 版本: 2024.12 剛剛發布

試用表格已提交成功地.

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號 立即。

試用表格已提交成功地.

受到全球數百萬工程師的信任

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號 立即。

受到全球數百萬工程師的信任

IronPDF 是 IRON 的一部分套件

準備開始了嗎？版本: 2024.12 剛剛發布

試用表格已提交
成功地.

獲取你的免費 0天試用序號立即。

試用表格已提交
成功地.

獲取你的免費 0天試用序號立即。