Visual Studio - Comentários da tag de resumo - Parâmetros opcionais

Question

Ao especificar comentários da tag de resumo, há uma maneira com a tag <param> de observar que um parâmetro é opcional, ou seja,o cliente pode fornecer um valor ou nulo, como: <param name="Mime" optional="true">.

O Google não me forneceu uma lista definida de atributos ou valores permitidos.

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

Obrigado

Answer 1

Não, você não pode.O único atributo reconhecido pelo VS é o name, como este:

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

A única coisa que você pode fazer - é definir xsl transform para o seu documento de saída.Mas isso não terá nenhum efeito no Intellisense.

Answer 2

Você deve fornecer uma sobrecarga que omita o parâmetro opcional:

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

Como alternativa, você pode declarar o parâmetro como opcional:

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

Você pode usar a tag <remarks></remarks>.Não existe tag especial para parâmetros opcionais.