232 votes

Comment référencer des classes génériques et méthodes dans la documentation xml

Lors de la rédaction de la documentation xml, vous pouvez utiliser <see cref="something">something</see>, ce qui fonctionne bien. Mais comment faites-vous référence à une classe ou une méthode avec les types génériques?

public class FancyClass<T>
{
  public string FancyMethod<K>(T value) { return "something fancy"; }
}

Si j'allais écrire de la documentation xml quelque part, comment aurais-je de référence de la fantaisie de la classe? comment puis-je faire référence à un FancyClass<string>? Que penser de la méthode?

Par exemple, dans une classe différente, je voulais laisser l'utilisateur de savoir que je vais retourner une instance de FancyClass<int>. Comment pourrais-je faire un see cref chose pour qui?

301voto

Lasse V. Karlsen Points 148037

Pour faire référence à la méthode :

47voto

<pre><code></code><p><a href="http://msdn.microsoft.com/en-us/library/acd0tfbe(VS.80).aspx">.Net framework 2.0</a> <a href="http://msdn.microsoft.com/en-us/library/acd0tfbe(VS.85).aspx">3.0</a> <a href="http://msdn.microsoft.com/en-us/library/acd0tfbe.aspx">version 3.5</a></p></pre>

10voto

Stephen Drew Points 524

Outre des réponses par Lasse et T.B.C :

fournira également des info-bulles correctement, alors que leur version rend les accolades.

1voto

Max Toro Points 13050
/// <see cref="FancyClass&lt;T>.FancyMethod&lt;K>(T)"/> for more information.

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