Pregunta

De acuerdo con este artículo , es posible obtener comentarios multilínea XML - en lugar de utilizar ///, el uso /** */. Esta es mi interpretación de lo que los comentarios de varias líneas son, y lo que queremos 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 se utiliza esta forma, la descripción que aparece cuando se ciernen sobre mi nombre de clase en mi código es de una sola línea, es decir, se ve exactamente como si hubiera escrito mi comentario como este:

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

¿Es realmente posible este comportamiento todavía en VS2008?

Editar

Gabe señalado que tengo lo que significa "varias líneas" mal entendido, y en realidad necesito usar <para> o <br> para conseguir mi efecto deseado. Seguí adelante y <br> usada 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 a la descripción de esta clase en mi código, todo lo que todavía termina en una línea ... WTH? ¿He hecho algo mal aquí?

Actualizar

Ok, se adelantó y trató la etiqueta <para> en cada línea, y que las obras. No sé por qué no lo hace <br/>.

/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
¿Fue útil?

Solución

Parece que usted está confundido acerca de lo que significa "multilínea". A fines de una sola línea de comentario al final de la línea de código fuente, y si desea continuar con ese comentario tienes que poner un "///" en la siguiente línea. A multi-línea de comentario comienza con una "/*" y termina con un "*/" por lo que puede terminar ya sea en la misma línea o varias líneas más abajo.

Siendo "multilínea" no dice nada acerca de cualquier forma en que se visualiza el texto dentro de los comentarios. Para poner un salto de línea en un comentario XML debe insertar una <br/> ( "break") o envuelva la línea en un <para> ( "punto") etiqueta.

Otros consejos

Probar

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

Añadir <br/> para saltos de línea o encerrar 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.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top