2009-01-12 17 views
8

Sé que tal vez sea una pregunta básica, pero parece que no puedo encontrar la respuesta en ningún lado.Mostrando clase genérica, por ejemplo, Tabla <String> en xml comentarios en visual studio

tengo una clase como esta

Table<T> 
{} 

luego tengo algo de código que utiliza la clase anterior que me gustaría hacer un comentario Me gustaría ser capaz de hacer algo como:

/// <summary> 
/// blah blah blah Table<String> 
/// </summary> 

Pero no puedo usar el corchete en el comentario porque cree que es una etiqueta y cuando aparece la ayuda solo tiene un error sobre la etiqueta sin final.

Cómo se muestran clases genéricas en comentarios en Visual Studio.

Respuesta

22

Necesita usar entidades XML (tipo de secuencias de escape): & lt; para < y & gt; para >. Intellisense mostrará < como y > correctamente.

EDITAR: He aquí una lista hoja de trucos de todas las entidades XML:

&lt; for < 
&gt; for > 
&amp; for & 
&quot; for " 
&apos; for ' 
2

intente utilizar un & lt; en lugar de <

0

El problema con & lt; es que se ve feo y es difícil de leer en los comentarios. Uso lo siguiente: GenericThing≪T,U≫. No se trata de dos caracteres de corchetes angulares, sino de un solo carácter. Se ve bien en Intellisense y al leer los comentarios. Si utiliza < summary> etc para generar la documentación, entonces no es estrictamente correcto, pero funciona para mí.

Cuestiones relacionadas