web-dev-qa-db-fra.com

référence à un type générique dans un commentaire de code XML

Comme je le sais, dans un commentaire XML pour un type/méthode C #, il est possible de référencer un type générique dans une balise comme ceci:

///<see cref="name.space.typename&lt;T&rt;(paramtype)">

Mais je pense qu'il y avait une autre syntaxe, qui est moins maladroite? Quelque chose, pour se débarrasser de ces entités html '<'? Je ne peux pas le trouver pour le moment. Quelqu'un peut-il aider?

c#xmldocumentationreferencegenerics
55
user492238

Voici un bon article sur la documentation: FAQ sur les commentaires de la documentation XML C #

L'équipe du compilateur a décidé d'améliorer cela en autorisant une syntaxe alternative pour faire référence aux types et méthodes génériques dans les commentaires de doc. Plus précisément, au lieu d'utiliser les crochets ouverts et fermés, il est légal d'utiliser les accolades ouvertes et fermées. L'exemple ci-dessus deviendrait alors:

class Program
{
    /// <summary>
    /// DoSomething takes a <see cref="List{T}"/>
    /// </summary>
    void DoSomething(List<int> al) { }
}

Donc, dans votre cas:

///<see cref="name.space.typename{T}( paramtype )" />

Edit: Le lien ci-dessus est en quelque sorte cassé; montre le html brut. Laissant le lien pour le moment. Voici quelques nouvelles références de Microsoft:

67
Metro Smurf

Utilisez des accolades:

///<see cref="name.space.typename{T}(paramtype)">
8
John Saunders