11
votes

Visual Studio - Résumé Tag Commentaires - Params facultatifs

Lorsque vous spécifiez les commentaires des balises récapitulatifs, est-il un moyen avec la balise à noter qu'un paramètre est facultatif, c'est-à-dire. Le client peut fournir une valeur ou une null, telle que: .

Googling n'a pas pu me fournir une liste d'attributs ou autorisé valeurs. xxx

merci


3 commentaires

La surcharge a été envisagée, mais j'ai décidé de cela dans cet exemple particulier.


Cette méthode fait partie d'une interface, j'ai senti que l'ajout d'une surcharge supplémentaire pour telle que de petits détails ne ferait que encombrer l'interface.


J'étais également curieux de savoir si ce type de commentaire était pris en charge avec l'ajout du nouveau paramètre facultatif disponible dans .NET 4.0 (comme mentionné ci-dessous).


3 Réponses :


1
votes

Vous pouvez utiliser tag. N'existe pas étiquette spéciale pour les paramètres facultatifs.


0 commentaires

7
votes

Non, vous ne pouvez pas. Le seul attribut étant reconnu par VS est le nom , comme celui-là: xxx

la seule chose que vous pouvez faire - est de définir XSL Transform pour votre document de sortie. Mais cela n'aura aucun effet sur IntelliSense.


0 commentaires

4
votes

Vous devez fournir une surcharge qui omett le paramètre facultatif:

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


0 commentaires