valid - summary c# documentation

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

Question

Esto debería ser más fácil ...

Quiero agregar un salto de línea "codificado" a la documentación XML en mi código

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// 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>

Como puede ver, encontré algunas respuestas que demostraron agregar <y> corchetes. Curiosamente, el buen salto de línea ''ol <br /> no crea un salto de línea en la ventana emergente Intellisense.

Encuentro esto molesto ...

¿Alguna sugerencia?

Answer 1

Agrega un <para /> . Esto te dará un descanso de párrafo.

Answer 2

Agregue una etiqueta <para> con un carácter especial, el 255 char o el carácter invisible .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Funcionará así:

Answer 3

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

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

Answer 4

<br></br> y <br /> no parecen funcionar, y algunas veces no se trata realmente de separar las oraciones <para> tanto como el deseo de tener una línea en blanco para separar las preocupaciones. Menciono esto aquí porque esta pregunta parece ser el padre de muchas preguntas cerradas de esta naturaleza.

Lo único que encontré para trabajar fue

<para>&#160;</para>

Por ejemplo

/// <summary>
/// <para>
/// "This sentence shows up when the type is hovered"
/// </para>
/// <para>&#160;</para>
/// <para>int PrimaryKey</para>
/// <para>&#160;</para>
/// <para>virtual Relation Relation</para>
/// </summary>

Resultados en

"This sentence shows up when the type is hovered"
int PrimaryKey
virtual Relation Relation