Comment ajouter un saut de ligne dans la documentation C# .NET

Question

Cela devrait être beaucoup plus facile...

Je veux ajouter un saut de ligne "codé" à la documentation XML dans mon code

/// <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>

Comme vous pouvez le voir, j'ai trouvé quelques réponses qui démontraient l'ajout de parenthèses < et >. Il est intéressant de noter que le bon vieux saut de ligne < br/ > ne crée pas de saut de ligne dans le popup Intellisense.

Je trouve cela ennuyeux...

Des suggestions ?

Answer 1

Vous pouvez utiliser un <para /> pour produire un saut de paragraphe ou vous pouvez envelopper le texte dans une balise <para></para> comme moyen de regrouper le texte et d'ajouter la ligne blanche après celui-ci, mais il n'existe pas d'équivalent à la balise <br /> ou autre chose du genre. (Ce qui, selon ce l'ancien post du forum MS est à dessein). Vous pouvez obtenir la liste des balises disponibles dans cet article de documentation de MS. Documenter votre code

Exemple (basé sur l'échantillon original de l'OP) :

/// <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>

Answer 2

À partir de Visual Studio 2019, utilisez <br/> pour les nouvelles lignes dans les commentaires.

Exemple :

/// <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>

Remarquez qu'il n'y a pas de ligne supplémentaire ajoutée lorsque nous utilisons <br/> au lieu de <para> .

Answer 3

C'est mon utilisation, comme <br/> ça marche :)

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

Answer 4

Ajouter un <para> contenant un caractère spécial, le caractère 255, ou char invisible .

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

Cela fonctionnera comme suit :

Answer 5

<br></br> et <br /> ne semblent pas fonctionner, et parfois il ne s'agit pas vraiment de faire le <para> des phrases séparées autant que le désir d'avoir une ligne blanche pour la séparation des préoccupations. Je le mentionne ici car cette question semble être le parent de nombreuses questions fermées de cette nature.

La seule chose que j'ai trouvée qui fonctionne est

<para>&#160;</para>

Par exemple

/// <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>

Résultats en

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation