Discussion :

[grunt2000]

Bonjour,

J'ai créé quelques classes et utilisé les directives <summary>, <param> et autres pour les documenter.
J'ai ensuite utilisé la commande csc pour compiler, et il y a un paramètre /doc:maDoc.xml que je peux utiliser pour produire un fichier xml de documentation...

... dont je ne peux rien faire, à priori...?
(en tout cas, pas le donner à lire à quelqu'un, c'est certain).

J'ai cherché sur internet et vu un outil NDoc, mais qui ne marche qu'en NET 1.1, il doit être trop vieux. J'ai aussi vu un outil Sandcastle, mais visiblement son installation est réputée complexe d'après ce que j'ai vu sur les forums.

Cette recherche m'a certainement mené beaucoup trop loin! Parce qu'il y a forcément une commande dans Microsoft Studio 2008 qui produit la documentation au format HTML déjà. Mais je n'arrive pas à mettre la main dessus.

Pouvez-vous me dire comment on procède?
Comment faites-vous au quotidien pour utiliser (ou transmettre) des APIs avec leur documentation?

En vous remerciant,

[Max]

Salut.

Personnellement, j'utilise Sandcastle qui me paraît plutôt abordable si tu en fais une utilisation basique. Si tu le télécharges, tu as juste à :

• lancer l'exe présent dans le répertoire d'installation ici : Sandcastle\Examples\generic\SandcastleGui.exe
• dans la partie Assemblies tu sélectionnes ton exe, ta dll, etc.
• dans Comments tu sélectionnes ton XML généré par VS

Et tu n'as plus qu'à cliquer sur Build Il te placera tes fichiers dans un sous-dossier de son répertoire d'installation (par défaut en tout cas).

[dtcSearch]

Personnellement,
j'ai suivi à peu de chose près:
http://philippe.developpez.com/articles/SandCastle/

Avec l'outils SandCastle Help File Builder c'est très simple.

[grunt2000]

Merci! Cela devrait permettre de m'en sortir.