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

196

Cela devrait être 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 ont démontré l'ajout de crochets <et>. Fait intéressant, le bon 'ol <br /> saut de ligne ne crée pas de saut de ligne dans la fenêtre contextuelle Intellisense.

Je trouve ça ennuyeux ...

Aucune suggestion?

Tinkerer_CardTracker
la source
3
Il est possible d'utiliser <br/> pour créer des sauts de ligne à partir de Visual studio 2019. Reportez-vous à la réponse ici .
23bl

Réponses:

314

Vous pouvez utiliser une <para />balise pour produire un saut de paragraphe ou vous pouvez encapsuler du texte dans des <para></para>balises pour regrouper le texte et ajouter la ligne vide après, mais il n'y a pas d'équivalent <br />ou quelque chose comme ça. (Ce qui, selon cet ancien article du forum MS, est de par sa conception.) Vous pouvez obtenir la liste des balises disponibles dans cet article de documentation de MS. Documenter votre code

Exemple (basé sur l'échantillon OP d'origine):

/// <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>
pstrjds
la source
5
Ah! Maintenant cuisinions! Merci! Cela me dérange depuis longtemps maintenant ... J'ai vu l'option para répertoriée, mais j'ai supposé qu'il s'agissait d'un raccourci "paramater".
Tinkerer_CardTracker
2
N'a pas travaillé pour moi. En utilisant VB.NET sur VS 2010, essayé avec et sans l'option de paramètre colorisée de Powertools, les <para>balises sont ignorées et tout est mélangé sur une seule ligne dans Intellisense. Trouvé cette question, où Hans a expliqué le problème: stackoverflow.com/questions/7070737/… .
Neolisk
1
Assurez-vous d'ajouter également la balise de fermeture </para> =)
link64
85
La mauvaise chose à ce sujet est qu'il ajoute en fait une ligne vierge entière, au lieu d'une nouvelle ligne.
Devid
6
Est-ce que quelqu'un a trouvé un moyen d'insérer une ligne au lieu de deux?
75

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

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>
IlPADlI
la source
8
Pourquoi cette réponse est-elle rejetée? Cela fonctionne, et semble être une bien meilleure solution que d'utiliser <para>&#160;</para>, <para>&nbsp;</para>ou le caractère invisible ...
Dinei
Cela fonctionne pour les retours à la ligne, mais n'insérera pas de ligne vierge entre les choses comme le font les autres options.
Yushatak
15
Dans les versions récentes de VS <para/>semble ajouter une ligne vierge, pas seulement un saut de ligne.
Dinei
2
@IlPADlI, +1 pour l'exemple d'utilisation. Confirmation du travail sur VS 2012 Ultimate Update 5.
Dennis T --Reinstate Monica--
9
VS 2017: ajout d'une ligne vierge, pas simplement d'une rupture de ligne ... Microsoft aime vraiment nous dire ce que nous voulons faire ...
Assimilater
39

Depuis Visual Studio 2019, utilisez <br/>pour les retours à la ligne 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>

entrez la description de l'image ici

Notez qu'aucune ligne supplémentaire n'est ajoutée lorsque nous utilisons à la <br/>place de <para>.

23bl
la source
4
Toujours utile, car cette question est le meilleur résultat Google pour savoir comment ajouter un saut de ligne dans la documentation C #.
Dan
27

Ajoutez une <para>balise contenant un caractère spécial, le 255 caractère ou le 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:

entrez la description de l'image ici

Joel
la source
8
Ceci est utile, mais &nbsp;ne fonctionne pas, utilisez plutôt/// <para>&#160;</para>
Robert H
1
Personnellement, je garde /// <para> </para>une note collante. Ensuite, il suffit de copier-coller! (Et ça marche - au moins pour moi)
Joel
2
Je ne sais pas pourquoi, mais le copier-coller /// <para> </para>ne fonctionne pas du tout. /// <para>&#160;</para>travaux!
wenqiang
8
Plutôt que d'utiliser la <para>balise entre les blocs de texte, vous devez utiliser la <para>balise autour de tous les paragraphes sauf le premier de l' <summary>élément. Pour les <typeparam>, <param>, <value>, <exception>et les <returns>éléments, les utiliser dans tous les paragraphes si vous avez plus d'un ( en option si vous avez seulement un pour ces éléments). Pour tous les autres éléments de bloc (y compris à l' <note>intérieur d'un autre élément de bloc), utilisez des <para>balises autour de tous les paragraphes, même si vous n'en avez qu'un.
Sam Harwell
1
Source: J'ai écrit ceci, y compris la plupart du style de présentation: openstacknetsdk.org/docs-master/html/…
Sam Harwell
3

<br></br>et <br />ne semblent pas fonctionner, et parfois il ne s'agit pas vraiment de <para>séparer les phrases autant que le désir d'avoir une ligne blanche pour la séparation des préoccupations. 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
Travis J
la source