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. <br/>
/// 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?
c#
.net
xml-documentation
Tinkerer_CardTracker
la source
la source
Réponses:
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 codeExemple (basé sur l'échantillon OP d'origine):
la source
<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/… .C'est mon utilisation, comme
<br/>
ça marche :)la source
<para> </para>
,<para> </para>
ou le caractère invisible ...<para/>
semble ajouter une ligne vierge, pas seulement un saut de ligne.Depuis Visual Studio 2019, utilisez
<br/>
pour les retours à la ligne dans les commentaires.Exemple:
Notez qu'aucune ligne supplémentaire n'est ajoutée lorsque nous utilisons à la
<br/>
place de<para>
.la source
Ajoutez une
<para>
balise contenant un caractère spécial, le 255 caractère ou le caractère invisible .Cela fonctionnera comme ceci:
la source
ne fonctionne pas, utilisez plutôt/// <para> </para>
/// <para> </para>
une note collante. Ensuite, il suffit de copier-coller! (Et ça marche - au moins pour moi)/// <para> </para>
ne fonctionne pas du tout./// <para> </para>
travaux!<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.<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
Par exemple
Résulte en
la source