61 votes

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

Que je sache, dans un commentaire XML pour un type C#/méthode, il est possible de faire référence à un type générique dans une balise comme ceci:

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

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

73voto

Metro Smurf Points 14234

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

Le compilateur équipe a décidé d'améliorer cela en permettant une syntaxe alternative pour se référer à des types génériques et des méthodes dans la doc de commentaires. Plus précisément, au lieu d'utiliser de l'ouvrir et de fermer l'angle entre parenthèses, il est légal d'utiliser à l' ouvrir et fermer des accolades. L' 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 )" />

9voto

John Saunders Points 118808

Utilisez des accolades:

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

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X