Visual Studio - 摘要标记注释 - 可选参数

Question

当指定摘要标签注释时，是否有一种使用 <param> 标签来注明参数是可选的，例如： <param name="Mime" optional="true">，即客户端可以提供一个值或 null 值。

通过搜索引擎无法找到属性列表或允许的值。

/// <summary>
/// Sets data associated with instance
/// </summary>
/// <param name="Key">The key defining the data</param>
/// <param name="Value">The data</param>
/// <param name="Mime">The mime type of the data (optional)</param>     <----- Mark as optional

感谢

- cweston

---

重载曾被考虑过，但在这个特定的例子中我决定不使用它。 - cweston

这个方法是接口的一部分，我认为为了这么小的细节添加额外的重载只会使接口变得混乱。 - cweston

我也很好奇，在.NET 4.0中是否支持这种类型的注释，因为有新的可选参数可用（如下所述）。 - cweston

Answer 1

不行，你不能这样做。Visual Studio 只识别 name 属性，像这样：

<param name="FileName" >The filename of the file to be loaded.</param>

你唯一能做的就是为输出文档设置xsl transform。但这对智能感知没有任何影响。

- VMAtm

Answer 2

您应该提供一个省略可选参数的重载函数：

/// <summary>
/// Sets data associated with the instance using the default media type.
/// </summary>
/// <param name="key">The key defining the data.</param>
/// <param name="value">The data.</param>
public void SetData(object key, object value)
{
    SetData(key, value, null);
}

/// <summary>
/// Sets data associated with the instance using the specified media type.
/// </summary>
/// <param name="key">The key defining the data.</param>
/// <param name="value">The data.</param>
/// <param name="mime">The media type of the data.</param>
public void SetData(object key, object value, string mime)
{
    ...
}

或者，您可以将参数声明为可选的：

/// <summary>
/// Sets data associated with the instance.
/// </summary>
/// <param name="key">The key defining the data.</param>
/// <param name="value">The data.</param>
/// <param name="mime">The media type of the data.</param>
public void SetData(object key, object value, string mime = null)
{
    ...
}

- dtb

Answer 3

您可以使用<remarks></remarks>标签。没有专门用于可选参数的标签。

- Kirill Polishchuk