voir la documentation de ces classes et méthodesRésolu

Question

Bonjour,

Suite à une prise de conscience soudaine ^^, j'ai décidé de commenter le code de certaines de mes classes. (balise ///Summary, params, etc;)

La documentation des classes se génère depuis l'IDE parfaitement (sharpdevelop)

Cependant je ne retrouve pas ces commentaires via la complétion de code lorsque j'utilise les méthodes et propriétés de ma classe commentée.

Est-ce normal ? Dites moi que non pitié lol

cs_Bidou · Accepted Answer

Juste une petite précison :
L'option est une case à cochée dans le 2ème onglet (Build) des options du projets.
Il est impératif que le nom du fichier Xml généré soit le même que le nom de l'assembly (comme le dit Luntinore). Sinon, VS n'arrive pas à le retrouver...
Pour une explication et un exemple d'utilisation des balises : http://vincentlaine.developpez.com/tuto/dotnet/comdoc/

<hr size= "2" /> VC#  forever
=13319

sebmafate · Answer

euh... le fichier xml... il n'est pas dans le répertoire bin ?

Sébastien FERRAND (
blog)
Consultant Indépendant
[Microsoft MVP Visual C#]

cs_Bidou · Answer

Par défaut, il let met dans le bin/debug ou le bin/release (tout dépend le mode de compilation au moment de cocher la checkBox).
Mais rien ne t'empêche de mettre le path que tu veux, non?

<hr size= "2" /> VC#  forever
=13319

cs_Bidou · Answer

Tiens non (après avoir testé) on peut spécifier 1 path pour chaque mode de compilation.

<hr size= "2" /> VC#  forever
=13319

georgeduke · Answer

Merci bcp pour ces précisions j'essaie ce soir et vous tiens au courant :-) (le xml se met dans mon debug effectivement)

georgeduke · Answer

Mon fichier xml se génère bien, il se mets bien dans debug - pas de problèmes d'assembly ; la doc se génere nickel

Mais aucun commentaire présent dans la complétion lorsque j'utilise les classes commentées...

J'utilise Sharpdelop ; serait-il impossible d'obtenir les commentaires via la complétion de code dans cet IDE ?

cs_Bidou · Answer

Alors là, aucune idée !
J'utilise seulement Visual Studio.... (le nom du file xml est bien le même que celui de la dll?)

<hr size= "2" /> VC#  forever
=13319/infomsg/auteurdetail.aspx?ID=13319

georgeduke · Answer

Ah mais c'est pas une dll Bidou ! ça serait pour ça ? (C'est juste une classe de mon projet) En tout cas le xml porte bien le même nom que l'exe du projet.

cs_Bidou · Answer

Ha ben si t'es dans le même projet, alors normalement il est capable de lire tout seul les commentaires que tu as mis (sans générer le fichier Xml)

<hr size= "2" /> VC#  forever
=13319

cs_Bidou · Answer

Ha ben si t'es dans le même projet, il est normalement capable de retrouver les commentaires que tu as mis sans générer le fichier Xml (maintenant, avec un autre IDE que Visual Studio, je ne sais pas...).

<hr size= "2" /> VC#  forever
=13319

georgeduke · Answer

Merci Bidou ! Ca m'embête cette histoire, je n'avais jusqu'alors rien à reprocher à Sharpdevelop... Il est léger, assez stable, super agréable à utiliser et gratuit. J'ai lu que Microsoft faisait des versions express de ces ide, j'vais ptetre essayer ^^

Mais ça m'embête de lacher SharpDevelop surtout à cause de la communauté qui travaille dessus et qui a fait un travail de qualité et ce bénévollement...

cs_Bidou · Answer

Salut,
Oui, il y a une version Express de Visual Studio qui est totalement gratuite (et qui le sera toujours; initialement, c'était prévu un an gratuit, puis payant).
Tu peux télécharger la version C# du logiciel ici. Evidemment, il y a quelques limitations par rapport à la version "normale", mais dans la plupart des cas, elle est suffisante.

<hr size= "2" /> VC#  forever
=13319

georgeduke · Answer

Ah d'accord c'est à vie maintenant ; plus d'excuses pour développer en C# alors maintenant ! Bah vu mon niveau la version express doit me suffire amplement. Merci du tuyau (et du lien ;-) )

cs_Bidou · Answer

De rien :-)

<hr size= "2" /> VC#  forever
=13319

Voir la documentation de ces classes et méthodes

14 réponses

Votre réponse

Discussions similaires