Visual Studio - Commenti tag di riepilogo - Parametri facoltativi

Question

Quando si specificano i commenti del tag di riepilogo, c'è un modo con il tag <param> per notare che un parametro è facoltativo, ad es.il client può fornire un valore o null, come: <param name="Mime" optional="true">.

Google non è riuscito a fornirmi un elenco di attributi o valori consentiti.

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

Grazie

Answer 1

No, non puoi.L'unico attributo riconosciuto da VS è il name, in questo modo:

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

L'unica cosa che puoi fare è impostare la xsl transform per il tuo documento di output.Ma questo non avrà alcun effetto su Intellisense.

Answer 2

Dovresti fornire un overload che ometta il parametro facoltativo:

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

In alternativa, puoi dichiarare il parametro come facoltativo:

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

Puoi utilizzare il tag <remarks></remarks>.Non esiste un tag speciale per i parametri facoltativi.