Générer une documentation sous Visual Studio 2005

Question

Hello! J'ai mis des commentaires sur mes WebMethod :

...

Je ne parviens pas à trouver comment générer à partir de là, la documentation web et XML sous Visual Studio 2005. Quelqu'un saurait-il comment faire pour générer cette documentation ?????

MorpionMx · Answer

Bonjour, on regardant l'aide, j'ai ca :

To generate an XML documentation file

With a project selected in Solution Explorer, on the Project menu, click Properties.
Click the Compile tab.
Select the Generate XML documentation file check box.

Je vois qu'avec la version express cependant, c'est dans l'onglet "Build", et non pas "Compile" Mx MVP C#

Arthenius · Answer

tu peux utiliser en suite ce fichier Xml pour generer un fichier d'aide bein complet avec le look msdn grace a Ndoc

http://ndoc.sourceforge.net/

<hr>Arthenius
http://blogs.developpeur.org/Arthenius/

"Ce qui ne me tue pas, me rend plus fort..."

leviz · Answer

Impossible, je n'y arrive pas!

Je sélectionne dans le Solution Explorer, dans le menu Project , je click Properties.
Ensuite je clique sur l'onglet Build.
Je n'arrive pas à sélectionner le check box Generate XML documentation file car il n'existe pas.

J'utilise Visual Studio 2005 Professional Edition

jhellier · Answer

Bonjour,


Je n'ai, pour ma part, pas de problème pour générer le fichier XML.
Il faut savoir que la case à cocher pour la sortie XML n'existe que pour les projets de type assembly et non pas pour les sites web, ce qui est logique...


En revanche, sous VS2003 il existait une commande du menu "Options" qui s'intitulait "Générer les pages web de commentaires"
et qui était fort pratique...

Quelqu'un saurait-il où a bien pu passer cette commande qui permettait d'obtenir un site web de documentation pour chaque classes de son code ?

Merci d'avance !

Jérôme HELLIER
Analyste / Développeur

MorpionMx · Answer

Salut

Il va falloir attendre sandcastle, qui est pour le moment en version CTP
Tu peux deja l'utiliser, par contre, c'est encore un peu fastidieux 

Sinon, tu peux utiliser ndoc comme le mentionne arthenius un peu plus haut
Mx
MVP C#

EMSIEN · Answer

MorpionMx j'ai du soucis à générer la doc avec SandCastle(CTP Mars), il me génèe l'erreur suivante, au cas ou tu l'a déjà rencontré ...:

Unhandled Exception: System.IO.FileNotFoundException: Could not find file 'C:\Pr
ogram Files\Sandcastle\Examples\Sandcastle\Output\html\d4648875-d41a-783b-d5f4-6
38df39ee413.htm'.

MorpionMx · Answer

Sincérement je sais pas, je n'ai pas encore utilisé cette CTP (bien qu'installée). T'es allé voir sur les forums msdn si d'autres rencontraient la meme erreur ?
T'as testé le projet d'exemple pour voir si t'avais le meme souci ?

Mx
MVP C#

EMSIEN · Answer

Le projet d'exemple marche très bien, il me génère la doc pour le fichier test.cs, mais pour ma part je veux savoir comment on pourra créer de la doc pour un projet contenant plusieurs répertoires et développé en VB.net.

Au cas ou tu as une procédure à suivre, parce que je me suis bien baladé un peu partout, la  MSDN aussi, j'ai même envoyé un e-mail à une personne de chez Microsoft mais encore aucune réponse...

si tu as du nouveau sur le sujet je suis preneur ;).

Bonne Journée à toi ...

koala59230 · Answer

Hello,
Pour info, je genere ma documentation avec
Sous VS 2003 : 
SandCastle CTP Mars 2007 + SandCastle Help File Builder + VBComment, pas de probleme
Je suis en train d'essayer de faire la même chose sous VS 2005 avec la meme configuration, mais mon fichier xml generé est vide. mais a priorie pas de probleme pour générer ma doc avec sanscastle
a+

sexy_developpeuse · Answer

salut,

je n'arrive non plus à trouver l'option qui me permettra de generer le fichier XML

est ce que vous avez une idée de comment faire sachant que je travail sur VS2005

EMSIEN · Answer

je confirme aussi, maintenant j'utilise Sandcastle Help File Builder (dispo par ici ), puis je donne ma dll à SHFB et il me génère ma doc sans soucis.

Il me reste par contre un soucis avec la génération de doc pour un site web ASP.NET, si quelqu'un a déjà une réponse sur ce sujet par ici.
Bon courage à vous.

P.S: pour la case à cocher pour génèrer le fihier XML, ça n'existe pas dans les projets te types Site par contre dans une librairie de classe c'est dispo.

Arthenius · Answer

alors pour les fichiers XML sur un projet style winform
clique droit sur le projet => Propriétés => Générer=> case a cocher : fichier de documentation XML : 

<hr />Arthenius
http://blogs.developpeur.org/Arthenius/

"Ce qui ne me tue pas, me rend plus fort..."

choko44 · Answer

Bonjour,

Je viens d'essayer sandcastle+ sandcastle help builder et le fichier chm est bien créé mais il n'y a aucune description.
Pourtant j'ai bien mis de sumary et le fichier xml de sortie n'est pas vide
J'ai vérifié si les namaspace était coché c'est le cas.

Donc je ne sais pas quoi faire
Si quelqun a une solution 

Merci d'avance

choko44 · Answer

En fait c'est bon
J'ai résolu mon problème :
dans les options visbility il fallait que je change les options par défaut

désolé

Générer une documentation sous Visual Studio 2005

14 réponses

Votre réponse

Discussions similaires