21 votos

Comentarios multilínea XML en C# - ¿Qué estoy haciendo mal?

Según este artículo es posible obtener comentarios XML de varias líneas, en lugar de utilizar /// Utilizar /** */ . Esta es mi interpretación de lo que son los comentarios multilínea, y lo que quiero que ocurra:

/**
 * <summary>
 * this comment is on line 1 in the tooltip
 * this comment is on line 2 in the tooltip
 * </summary>
 */

Sin embargo, cuando utilizo este formulario, el tooltip que aparece cuando paso el ratón por encima del nombre de mi clase en mi código es de una sola línea, es decir, se ve exactamente como si hubiera escrito mi comentario así:

/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>

¿Es posible este comportamiento todavía en VS2008?

EDITAR

gabe me ha señalado que he entendido mal lo que significa "multilínea", y que en realidad tengo que usar <para> o <br> para conseguir 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 para esta clase en mi código, todo sigue terminando en una línea... ¿QUÉ? ¿He hecho algo mal aquí?

ACTUALIZACIÓN

Ok, me adelanté y probé el <para> en cada línea, y eso funciona. No sé 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>

15voto

Gabe Puntos 49718

Parece que está confundido sobre lo que significa "multilínea". Un comentario de una línea termina al final de la línea de código fuente, y si quieres continuar ese comentario debes poner un " /// "en la línea siguiente. Un comentario de varias líneas comienza con un " /* " y termina con un " */ "para que pueda terminar en la misma línea o en varias líneas más abajo.

El hecho de ser "multilínea" no dice nada sobre cómo se muestra el texto dentro del comentario. Para poner un salto de línea en un comentario XML hay que insertar un <br/> ("break") o envolver la línea en un <para> ("párrafo").

11voto

bic Puntos 1171

Prueba esto

/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

1voto

Lucero Puntos 38928

Añadir <br/> para los saltos de línea o encerrar los párrafos en <para>...</para> . Es igual que XML y HTML, el salto de línea no es más que un espacio en blanco.

Iteramos.com

Iteramos es una comunidad de desarrolladores que busca expandir el conocimiento de la programación mas allá del inglés.
Tenemos una gran cantidad de contenido, y también puedes hacer tus propias preguntas o resolver las de los demás.

Powered by:

X