Visual Studio - 摘要標記注釋 - 可選參數

Question

在指定摘要標記注釋時，是否有一種方法可以使用<param>標記來指出參數是可選的，即。 客戶端可以提供值或null，例如： <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>標記。 不存在可選參數的特殊標記。