2011-02-17 8 views
42

que yo sepa, en un comentario XML para un C#/tipo de método, es posible hacer referencia a un tipo genérico en una etiqueta de este modo:referencia al tipo genérico en XML comentario código

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

Pero creo , hubo otra sintaxis, que es menos torpe? Algo, para deshacerse de esas entidades html '<'? No puedo encontrarlo ahora. ¿Alguien puede ayudar?

Respuesta

58

Aquí está un buen artículo sobre la documentación: C# XML documentation comments FAQ

El equipo compilador decidió mejorar esto permitiendo una sintaxis alternativa para referirse a los tipos y métodos genéricos en los comentarios del doc. Específicamente, en lugar de utilizar las corcheas angulares abiertas y cerradas , es legal usar las llaves para abrir y cerrar. El ejemplo anterior se convertiría entonces en:

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

Así, en su caso:

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

Sí, pero las llaves no aparecen en Visual Studio (2005..2012) Intellisense como ' {T} ', no como' '. –

+3

@PierreArnaud - FWIW, el nuevo análisis de idioma basado en Roslyn en Visual Studio 2015 ahora muestra correctamente la referencia a la lista como 'Lista ' en lugar de 'List {T}' en la información sobre herramientas :) –

7

Use llaves:

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