valid - Comentarios de multilínea XML en C#- ¿Qué estoy haciendo mal?
summary example c# (3)
Según este artículo , es posible obtener comentarios XML multilínea; en lugar de utilizar /// , use /** */ . Esta es mi interpretación de lo que son los comentarios de varias líneas y lo que quiero que suceda:
/**
* <summary>
* this comment is on line 1 in the tooltip
* this comment is on line 2 in the tooltip
* </summary>
*/
Sin embargo, cuando uso este formulario, la información sobre herramientas que aparece al desplazarme sobre el nombre de mi clase en mi código es de una sola línea, es decir, parece exactamente como si hubiera escrito mi comentario de esta forma:
/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>
¿Es este comportamiento realmente posible todavía en VS2008?
EDITAR
gabe señaló que he entendido mal lo que significa "multilínea", y en realidad necesito usar <para> o <br> para obtener el efecto deseado. Seguí adelante y utilicé <br> porque quiero controlar dónde se producen los saltos de línea, es decir,
/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>
Cuando miro la información sobre herramientas de esta clase en mi código, todo termina en una línea ... ¿QUÉ? ¿Hice algo mal aquí?
ACTUALIZAR
Ok, seguí adelante y probé la etiqueta <para> en cada línea, y eso funciona. No estoy seguro de por qué <br/> no lo hace.
/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
Agregue <br/> para los saltos de línea o incluya los párrafos en <para>...</para> . Es como XML y HTML, el salto de línea no es más que un espacio en blanco.
Parece que estás confundido acerca de lo que significa "multilínea". Un comentario de una sola línea finaliza al final de la línea del código fuente y, si desea continuar ese comentario, debe poner una " /// " en la siguiente línea. Un comentario de varias líneas comienza con " /* " y termina con " */ ", por lo que puede terminar en la misma línea o en varias líneas hacia abajo.
Al ser "multilínea" no dice nada sobre cómo se muestra el texto dentro del comentario. Para colocar un salto de línea en un comentario XML, debe insertar un <br/> ("salto") o envolver la línea en una etiqueta <para> ("párrafo").
Prueba esto
/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>