web-dev-qa-db-fra.com

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

Cela devrait être plus facile ...

Je souhaite 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 constater, j'ai trouvé des réponses qui démontraient l'ajout de crochets <et>. Fait intéressant, le bon saut de ligne <br /> ne crée pas de saut de ligne dans la fenêtre contextuelle d'Intellisense.

Je trouve ça agaçant ...

Aucune suggestion?

c#.netxml-documentation
175
Tinkerer_CardTracker

Vous pouvez utiliser un <para /> balise pour produire un saut de paragraphe ou vous pouvez insérer du texte dans <para></para> balises pour regrouper le texte et ajouter la ligne vide après celle-ci, mais il n’ya pas d’équivalent à <br /> ou quelque chose comme ça. (Selon this , l'ancien message sur le forum MS est conçu de manière intentionnelle.) Vous pouvez obtenir la liste des balises disponibles dans cet article de documentation auprès de MS. Documenter votre code

Exemple (basé sur l'échantillon OP initial):

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

Ceci est mon usage, comme <br/> , ça marche :)

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

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

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

Cela fonctionnera comme ceci:

enter image description here

25
Joel

<br></br> et <br /> ne semble pas fonctionner, et parfois il ne s’agit pas vraiment de faire le <para> _ phrases séparent autant que le désir d’avoir une ligne blanche pour se séparer. Je le mentionne ici parce que cette question semble concerner de nombreuses questions fermées de cette nature.

La seule chose que j'ai trouvée pour travailler était

<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ésulte en

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
3
Travis J

A partir de Visual Studio 2019, commenter avec <br/> est pris en charge pour la création de commentaires avec une nouvelle ligne.

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

Vous pouvez voir l'exemple ci-dessus en action dans l'image suivante.

enter image description here

Notez qu'il n'y a pas de ligne supplémentaire ajoutée lorsque nous utilisons <br/>tiquette par opposition à l'utilisation de <para> tag.

0
23bl