编辑“︁C Sharp 可选参数”︁

= C#可选参数 =

== 介绍 ==
'''可选参数'''是C#方法中一种允许调用者省略某些参数的语法特性。通过为参数指定默认值，可以在调用方法时选择性传递部分参数，而未传递的参数将使用预定义的默认值。这一特性在提高代码灵活性和减少方法重载数量方面非常有用。

可选参数在C# 4.0中引入，通常与'''命名参数'''结合使用，以增强代码可读性。

== 语法 ==
可选参数的声明方式是在方法签名中为参数赋值默认值：

<syntaxhighlight lang="csharp">
返回类型 方法名(数据类型 参数名 = 默认值)
</syntaxhighlight>

== 基本示例 ==
以下是一个简单的可选参数示例：

<syntaxhighlight lang="csharp">
public void PrintMessage(string message = "Hello, World!", int repeat = 1)
{
    for (int i = 0; i < repeat; i++)
    {
        Console.WriteLine(message);
    }
}

// 调用示例
PrintMessage(); // 使用所有默认参数
PrintMessage("Custom Message"); // 只提供message参数
PrintMessage(repeat: 3); // 使用命名参数只指定repeat
PrintMessage("Hi", 2); // 提供所有参数
</syntaxhighlight>

'''输出:'''
<pre>
Hello, World!
Custom Message
Hello, World!
Hello, World!
Hello, World!
Hi
Hi
</pre>

== 规则与限制 ==
1. 可选参数必须出现在方法参数列表的'''最后'''，在所有必需参数之后
2. 默认值必须是'''编译时常量'''（数字、字符串、null、const值等）
3. 不能使用'''ref'''或'''out'''参数作为可选参数
4. 可选参数会影响方法调用的'''重载解析'''

== 高级用法 ==

=== 与命名参数结合 ===
可选参数常与命名参数一起使用，提供更灵活的调用方式：

<syntaxhighlight lang="csharp">
public void ConfigureServer(string host, int port = 80, bool enableSSL = false, int timeout = 30)
{
    // 配置逻辑
}

// 调用示例
ConfigureServer("example.com"); // 只提供必需参数
ConfigureServer("example.com", enableSSL: true); // 跳过port参数
ConfigureServer("example.com", timeout: 60, port: 8080); // 任意顺序命名参数
</syntaxhighlight>

=== 可选参数与重载 ===
可选参数可以替代某些方法重载场景：

<mermaid>
graph LR
    A[传统重载方法] --> B[方法1 int x]
    A --> C[方法2 int x, int y]
    A --> D[方法3 int x, int y, int z]
    E[使用可选参数] --> F[单一方法 int x, int y=0, int z=0]
</mermaid>

== 实际应用案例 ==

=== 数据库连接配置 ===
<syntaxhighlight lang="csharp">
public DbConnection CreateConnection(
    string server,
    string database,
    string username = "sa",
    string password = "",
    int timeout = 15,
    bool pooling = true)
{
    // 创建连接字符串并建立连接
    string connectionString = $"Server={server};Database={database};" +
                             $"User Id={username};Password={password};" +
                             $"Connection Timeout={timeout};Pooling={pooling}";
    return new SqlConnection(connectionString);
}

// 调用示例 - 不同配置场景
var devConnection = CreateConnection("localhost", "DevDB");
var prodConnection = CreateConnection("db.prod.com", "ProdDB", "admin", "securePass123");
var testConnection = CreateConnection("test.db.com", "TestDB", timeout: 30, pooling: false);
</syntaxhighlight>

=== 日志记录函数 ===
<syntaxhighlight lang="csharp">
public void Log(
    string message,
    LogLevel level = LogLevel.Info,
    bool timestamp = true,
    string source = "Application",
    bool writeToFile = false)
{
    string logEntry = timestamp ? $"[{DateTime.Now}] " : "";
    logEntry += $"{source} [{level}]: {message}";
    
    Console.WriteLine(logEntry);
    if (writeToFile)
    {
        File.AppendAllText("log.txt", logEntry + Environment.NewLine);
    }
}

// 调用示例
Log("Starting application"); // 简单日志
Log("Error occurred", LogLevel.Error, source: "Database"); // 指定部分参数
Log("Critical failure", writeToFile: true, level: LogLevel.Critical); // 命名参数乱序
</syntaxhighlight>

== 数学公式示例 ==
可选参数在数学函数中也很实用，例如计算圆柱体积：

<math>V = \pi r^2 h</math>

<syntaxhighlight lang="csharp">
public double CalculateVolume(
    double radius,
    double height,
    double pi = Math.PI,
    int decimalPlaces = 2)
{
    double volume = pi * Math.Pow(radius, 2) * height;
    return Math.Round(volume, decimalPlaces);
}

// 调用示例
var v1 = CalculateVolume(5, 10); // 使用默认π值和2位小数
var v2 = CalculateVolume(5, 10, decimalPlaces: 4); // 指定精度
var v3 = CalculateVolume(5, 10, 3.14159); // 自定义π近似值
</syntaxhighlight>

== 注意事项 ==
1. '''默认值陷阱'''：默认值在编译时确定，不是运行时。修改默认值需要重新编译所有调用代码。
2. '''版本控制'''：添加新的可选参数是二进制兼容的，但移除或修改现有可选参数会破坏兼容性。
3. '''重载优先级'''：当存在重载时，编译器会优先选择不需要填充可选参数的重载。

== 最佳实践 ==
* 为可选参数选择合理的默认值
* 避免过多可选参数（通常不超过3-4个）
* 对布尔参数考虑使用枚举替代
* 复杂的配置场景考虑使用Builder模式替代多个可选参数

== 总结 ==
C#的可选参数提供了一种灵活的方法设计方式，可以：
* 减少方法重载数量
* 提高API的易用性
* 增强代码可读性（特别是与命名参数结合时）

合理使用可选参数可以创建更简洁、更易维护的代码，但需要注意其适用场景和潜在的限制。

[[Category:编程语言]]
[[Category:C Sharp]]
[[Category:C Sharp 函数]]