XML commentaire sur plusieurs lignes en C# - ce que je fais mal?
Selon cet article, il est possible d'obtenir des commentaires XML multilignes -- au lieu d'utiliser ///
, utilisez /** */
. Voici mon interprétation de ce que sont les commentaires multilignes, et de ce que je veux qu'il arrive:
/**
* <summary>
* this comment is on line 1 in the tooltip
* this comment is on line 2 in the tooltip
* </summary>
*/
cependant, lorsque j'utilise ce formulaire, l'infobulle qui apparaît lorsque je survole mon nom de classe dans mon code est une ligne simple, c'est-à-dire qu'il semble exactement comme si j'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-il réellement encore possible en VS2008?
EDIT
gabe fait remarquer que j'ai mal compris ce que" multiligne " signifie, Et je dois en fait 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 le tooltip de cette classe dans mon code, tout finit toujours sur une ligne... WTH? Ai-je fais quelque chose de mal ici?
UPDATE
Ok, je suis allé de l'avant et a essayé de la <para>
tags sur chaque ligne, et ça marche. Je ne sais pas pourquoi <br/>
doesn'T.
/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
3 réponses
on dirait que vous êtes confus sur ce que "multi-ligne" signifie. 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 de plusieurs lignes commence par un "/*
" et se termine par un "*/
" de sorte qu'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 le texte dans le commentaire est affiché. Pour mettre un saut de ligne dans un XML commentaire vous devez insérer un <br/>
("pause") ou d'enrouler la ligne <para>
("paragraphe") de la balise.
Essayez ceci
/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
Ajouter <br/>
pour les sauts de ligne ou de joindre les paragraphes <para>...</para>
. C'est juste comme XML et HTML, la rupture de ligne n'est rien d'autre que des espaces.