2011-04-28 15 views
5

Tengo regiones y varios métodos dentro de esas regiones. Cuando agrego comentarios XML a la parte superior de los métodos y contrae el comentario xml, se muestra algo así como "/// ..." que es "sin idioma". ¿Cómo puedo hacer que muestre el contenido dentro de la etiqueta de resumen cuando se contrae?Comentarios XML en C# no muestran el resumen que muestran xml

VS 2008 Pro .NET 3.5 SP1

Gracias!

Matt

Respuesta

2

Si se escribe el resumen todo en una línea, como por ejemplo:

/// <summary>My summary.</summary> 

... verá el resumen cuando está plegado.

Francamente, este enfoque no me gusta, porque mis resúmenes generalmente son más largos que los que caben cómodamente en una línea.

+0

Votaría esto pero no tiene suficiente poder de voto todavía. Incluso llegaría tan lejos como fuera razonable para adaptar su resumen en una sola línea. Y

están siempre en múltiples líneas por defecto. ¿Estoy atascado con esto? –

+0

@Matt: me temo que sí. Puede haber complementos que puedan ayudar, pero yo no uso ninguno. Esta entrada de MSDN (http://msdn.microsoft.com/en-us/magazine/dd722812.aspx) menciona algunos de los ingeniosos comentarios basados ​​en WPF que se prometieron con VS2010; sin embargo, parece ser el caso de que VS2010 en realidad no incluía la funcionalidad. – kbrimington

0

El bloque de comentario contraído mostrará la primera línea del comentario hasta que lo expanda. Por lo tanto, se puede dar formato a los comentarios XML para incluir una porción representativa del resumen en la primera línea:

/// <summary>The most important part of your comment on the first line 
    /// and other stuff following on subsequent lines.</summary> 
    public static void DoStuff() 
    { 
     // ... 
    } 

colapsará a:

/// <summary>The most important part of your comment on the first line ... 
    public static void DoStuff() ... 
+1

Gracias por su respuesta. Deseo que Microsoft haga que el texto colapsado de un comentario xml tenga el valor entre

. De esta manera, los comentarios también serían significativos en el estado colapsado. –

Cuestiones relacionadas