XML commentaires multilignes en C # - ce que je fais mal?
-
23-09-2019 - |
Question
Selon cet article , il est possible de obtenir des commentaires XML multilignes - au lieu d'utiliser ///
, utilisez /** */
. Ceci est mon interprétation de ce que les commentaires sont multilignes, et ce que je veux voir se produire:
/**
* <summary>
* this comment is on line 1 in the tooltip
* this comment is on line 2 in the tooltip
* </summary>
*/
Cependant, quand j'utiliser ce formulaire, l'info-bulle qui apparaît lorsque je passe la souris sur mon nom de classe dans mon code est unique en ligne, à savoir qu'il ressemble exactement comme si je l'avais écrit mon commentaire comme ceci:
/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>
Ce comportement est en fait possible encore VS2008?
EDIT
gabe a fait remarquer que j'ai mal compris ce que « multilignes » signifie, et j'ai réellement besoin d'utiliser <para>
ou <br>
pour obtenir mon effet escompté. Je suis allé de l'avant et utilisé <br>
parce que je veux contrôler où les sauts de ligne se produisent, i.e..
/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>
Quand je regarde l'info-bulle pour cette classe dans mon code, tout se termine toujours sur une ligne ... WTH? Est-ce que je fais quelque chose de mal ici?
UPDATE
Ok, je suis allé de l'avant et a essayé la balise <para>
sur chaque ligne, et qui fonctionne. Je ne sais pas pourquoi <br/>
ne fonctionne pas.
/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
La solution
On dirait que vous êtes confus au sujet de ce que signifie « multilignes ». Un commentaire sur une seule ligne se termine à la fin de la ligne de code source, et si vous voulez continuer ce commentaire vous devez mettre un « ///
» sur la ligne suivante. Un commentaire multi-ligne commence par un « /*
» et se termine par un « */
» il peut se terminer soit sur la même ligne ou plusieurs lignes vers le bas.
Être « multi-ligne » ne dit rien sur la façon dont tout le texte dans le commentaire est affiché. Pour mettre un saut de ligne dans un fichier XML des commentaires, vous devez insérer un <br/>
( « break ») ou envelopper la ligne dans une balise <para>
( « paragraphe »).
Autres conseils
Essayer cette
/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
Ajoutez <br/>
pour les sauts de ligne ou joindre les paragraphes <para>...</para>
. Il est comme XML et HTML, le saut de ligne est rien, mais des espaces blancs.