Discussion :

[BenoitM]

Bonjour,

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
/// <summary>
/// Lecture de l'etudiant dont:
/// name(db) == Name && DateNaiss(db) <= DateNaissance
///</summary>

J'ai ce genre de commentaire pour une fonction mais quand je l'utilise VS n'aime pas le && et < je dois les remplacer par &amp; et &lt;

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
/// <summary>
/// Lecture de l'etudiant dont:
/// name(db) == Name &amp;&amp; DateNaiss(db) &lt;= DateNaissance
///</summary>

Du coups ca rend le tooltips lisible part contre quand on est dans le fichier source c'est pas très lisible

je suis étonné qu'il ne rale pas sur le ' mais bon on va pas se plaindre

Il y a pas un moyen de dire "n'interpretre pas les caractères qui suivent"?
genre en c# on met @"c:\"

Merci

[giova_fr]

Je ne pense pas que tu puisse, vu que ca sert à la génération de docs dans d'autres formats que le c#

au pire :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

name(db) EQUAL Name AND DateNaiss(db) INF_EQUAL DateNaissance

[Max]

Salut.

À ma connaissance, ce n'est pas possible, car c'est du XML pur et dur qui est attendu. Et comme tu l'as fait remarquer, en XML le & c'est &amp;.

Et pour pinailler sur ton exemple , je dirais que du code n'a rien à faire dans la balise <summary> et de facto dans le tooltip. Si tu veux mettre du code dans ton header (ce qui sera formidable, par exemple, pour celui qui lira la documentation de ton API), mieux vaut utiliser les balises <c>, <code> (via <example>) ou autre.

Cordialement.

[ctxnop]

Il y a pas un moyen de dire "n'interpretre pas les caractères qui suivent"?
genre en c# on met @"c:\"

Salut,
Il ne rale pas sur l'apostrophe parce que ce n'est pas de l'html mais du XML.
Les seuls caractères interdits sont donc ceux qui entrent en conflit avec le balisage : < > et &.
Le & entre en conflit car c'est le caractère qui permet d'ajouter un entity.
Pour ajouter des données qui ne seront pas interprétées il faut, comme l'impose la norme XML, les placer dans un bloc CDATA :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
 
/**
<summary>
<![CDATA[
name(db) == Name && DateNaiss(db) <= DateNaissance
]]>
</summary>
*/

Seulement l'intellisense n'utilisera pas ce qui est dans le bloc CDATA et il faut utiliser la syntaxe de commentaire multiligne car sinon les "///" présents en début de chaque ligne risquent d'être intégrés en tant que données dans le bloc CDATA.
Du coup il est préférable d'utiliser les balises prévues à cet effet comme le suggère _Max_

[BenoitM]

...

Oui c'est une idée aussi

...

Ah bon je regarderai demain pour les commentaires des classes, en fait je n'ai fais que recopier la structure des commentaires qui était utilisé là où je travaille
Je garderai surement celle de mon entreprise pour garder la même convention mais c'est toujours bon d'apprendre les bonnes pratiques

...

Ah oui merci de me rafraichir la mémoire avec le <![CDATA[]]>

Vive la mémoire de poisson rouge

Merci à vous tous
Je testerai demain pour voir la solution que j'adopte