Cómo agregar un salto de línea en la documentación de C# .NET

 C Programming >> Programación C >  >> Tags >> .NET
Cómo agregar un salto de línea en la documentación de C# .NET

Puedes usar un <para /> etiqueta para producir un salto de párrafo o puede ajustar el texto en <para></para> etiquetas como una forma de agrupar el texto y agregar una línea en blanco después, pero no hay un equivalente a <br /> o algo por el estilo. (Lo cual, según esta antigua publicación del foro de MS, es por diseño). Puede obtener la lista de etiquetas disponibles en este artículo de documentación de MS. Documentando tu código

Ejemplo (basado en la muestra OP original):

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Este es mi uso, como <br/> , está funcionando :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

A partir de Visual Studio 2019, use <br/> para líneas nuevas en los comentarios.

Ejemplo:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

Tenga en cuenta que no se agrega una línea adicional cuando usamos <br/> en lugar de <para> .