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

Question

在指定摘要标签注释时，标签是否有办法<param>注意参数是可选的，即。客户端可以提供一个值或空值，例如：<param name="Mime" optional="true">.

谷歌搜索未能为我提供一组属性或允许值。

/// <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

谢谢

Answer 1

不，你不能。VS 识别的唯一属性是name，如下所示：

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

您唯一能做的就是为您的输出文档设置xsl 转换。但这不会对 Intellisense 产生任何影响。

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)
{
    ...
}

Answer 3

您可以使用<remarks></remarks>标签。不存在可选参数的特殊标签。