2011-02-17 2 views
42

Comme je sais, 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:référence type générique dans le code XML commentaire

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

Mais je pense , 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 maintenant. Quelqu'un peut-il aider?

Répondre

58

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

L'équipe du compilateur a décidé d'améliorer ce en permettant une autre syntaxe de se référer aux types et méthodes génériques dans les commentaires doc. Spécifiquement, au lieu d'utiliser les cornières d'ouverture et de fermeture, 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) { } 
} 

Ainsi, dans votre cas:

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

Oui, mais les accolades n'apparaissent dans Visual Studio (2005..2012) IntelliSense comme ' {T} ', pas comme' '. –

+3

@PierreArnaud - FWIW, la nouvelle analyse de langage basée sur Roslyn dans Visual Studio 2015 affiche désormais correctement la référence à la liste en tant que 'Liste ' au lieu de 'Liste {T}' dans l'info-bulle :) –

7

Utilisez des accolades:

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