Visual Studio - Résumé Tag Commentaires - En option Params

Question

Lors de la spécification des commentaires d'étiquette de synthèse, est-il un moyen avec la balise <param> de noter qu'un paramètre est facultatif, à savoir. le client peut fournir une valeur nulle ou, par exemple: <param name="Mime" optional="true">.

recherche sur Google ne m'a pas fournir une liste ensemble d'attributs ou valeurs autorisées.

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

Merci

Answer 1

Non, vous ne pouvez pas. Le seul attribut étant reconnu par VS est le name, comme ça:

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

La seule chose que vous pouvez faire - est de définir xsl transformer pour votre document de sortie. Mais cela n'a aucun effet sur IntelliSense.

Answer 2

Vous devez fournir une surcharge qui passe sous silence le paramètre optionnel:

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

Vous pouvez déclarer le paramètre en option:

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

Vous pouvez utiliser la balise <remarks></remarks>. N'existe pas balise spéciale pour params en option.