如何通过XML注释在IntelliSense中标识方法参数默认值？

嘿，这个场景我太熟悉了！给那些调用主方法的重载方法标注默认参数值，其实有几个既通用又醒目的XML文档技巧，分享给你：

1. 直接在<param>标签内强调默认值 #

这是兼容性最好的方式，所有支持XML文档的IDE和工具都能识别。你可以在参数描述里用*包裹默认值，让它在IDE提示和生成的文档里都格外醒目：

/// <summary>
/// 发送HTTP请求的重载方法（仅指定地址）
/// </summary>
/// <param name="url">请求的目标地址</param>
/// <remarks>未指定的参数将使用默认值：超时时间*5000ms*、请求方法*GET*</remarks>
public void SendRequest(string url)
{
    SendRequest(url, 5000, HttpMethod.Get);
}

/// <summary>
/// 发送HTTP请求的重载方法（指定地址和超时）
/// </summary>
/// <param name="url">请求的目标地址</param>
/// <param name="timeout">请求超时时间，*默认值：5000ms*</param>
public void SendRequest(string url, int timeout)
{
    SendRequest(url, timeout, HttpMethod.Get);
}

2. 用<remarks>关联主方法的全局默认值 #

如果多个重载共用同一套默认值，你可以在主方法的<remarks>里统一定义默认值规则，然后在重载方法里引用，避免重复书写：

/// <summary>
/// 发送HTTP请求的核心主方法
/// </summary>
/// <param name="url">请求的目标地址</param>
/// <param name="timeout">请求超时时间（毫秒）</param>
/// <param name="method">HTTP请求方法</param>
/// <remarks>
/// 所有重载方法未指定的参数将使用以下默认值：
/// - timeout：5000ms
/// - method：HttpMethod.Get
/// </remarks>
public void SendRequest(string url, int timeout, HttpMethod method)
{
    // 主方法业务逻辑
}

/// <summary>
/// 发送HTTP请求的重载方法（仅指定地址）
/// </summary>
/// <param name="url">请求的目标地址</param>
/// <remarks>未指定参数将遵循<see cref="SendRequest(string, int, HttpMethod)"/>中定义的默认值</remarks>
public void SendRequest(string url)
{
    SendRequest(url, 5000, HttpMethod.Get);
}

3. 针对可选参数的<value>标签（VS专属优化） #

如果你用的是C#可选参数（即参数自带= 默认值的语法），Visual Studio的IntelliSense支持在<param>里嵌套<value>标签来标注默认值，显示效果会更规整：

/// <summary>
/// 发送HTTP请求的重载方法
/// </summary>
/// <param name="url">请求的目标地址</param>
/// <param name="timeout">请求超时时间<value>5000</value>（毫秒）</param>
public void SendRequest(string url, int timeout = 5000)
{
    SendRequest(url, timeout, HttpMethod.Get);
}

需要注意的是，官方XML文档规范里并没有专门的<default>标签，所以上面这些方法都是基于通用规范和主流IDE/工具的支持来实现的，其中第一种方法是最稳妥的跨工具方案。

内容的提问来源于stack exchange，提问作者G_Hosa_Phat