Generer documentation

Question

Salut,

Existe-t-il, a l'heure actuelle, une solution efficace pour generer de la documentation pour VS 2005 en mode Web ?
Pour des projets C# ou VB, il est possible de generer un fichier de doc XML (projet -> proprietés -> generer), mais je n'arrive à trouver cette option en mode ASP (pas de menu projet).

Comment faire ?

D@runia

jesusonline · Answer

Bonjour, 


Pourquoi vouloir générer de la doc sur un projet web ? Si tu sépares bien tes différentes couches ton projet web ne te sert qu'a afficher les datas et surtout personne n'a a réutiliser ce code ... donc la documentation n'est pas utile (ce qui ne veut pas dire que les commentaires sont inutiles dans ce cas ;)) 


Il y a peut etre une option mais je ne la connais pas, et puis c'est techniquement compliqué vu que chaque fichier de code est compilé indépendamment des autres ... 


Attend le chateau de sable qui peut etre resolvera tout ca :-)





<hr />
Cyril - MVS - MCP

cs_darunia · Answer

C'est que je voulais documenter mes classes métiers, mais je vais faire un projet C# bidon et ça marchera.
Sinon, j'attends avec impatience un vrai outil integré dans VS (SandCastle dans le SP1 aux dernieres nouvelles).

Merci et a+

D@runia

EMSIEN · Answer

salut à tous,
je cherche aussi un outil pour la génération de la doc sous .NET 2.0 (pour des projets en VB.net), j'ai essayé SandCastle (CTP de MARS) mais elle me génère cette erreur :

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'.

Cyril quel outil tu utilise lorsque tu veux générer de la doc sous Dontet, je sais que Ndoc n'est plus supporté et je me suis dit qu'il ya surement un moyen quelques parts pour générer de la doc n'est ce pas???

Bonne Journée à vous ...

jesusonline · Answer

non il n'y a que SandCastle :-( et c'est pas évident à configurer mais c'est faisable :-p

<hr />Cyril - MSP - MCTS ASP.net & SQL

EMSIEN · Answer

j'ai utilisé un outil graphique créée par Stephen Smesters, mais ça me donne cette erreur:

An error occured during the generation of the documentation. Possibly this was caused by an inaccessible Microsoft webservice that returns MSDN urls.

je suis plein d'erreurs moi, mais je garde espoir et je continue mes recherches...

Ehh cyril si tu pouvais nous faire un article sur ton blog :d :$ ça serait coool...

EMSIEN · Answer

CoOoOol ça marche, maintenant je génère de la documentation ;)
fallait enlever les cotes en executant le batch dans l'exemple sur le CTP ...
Merci encore

jesusonline · Answer

Il te reste plus qu'a faire un article sur le sujet ;-) 

<hr />Cyril - MSP - MCTS ASP.net & SQL

Generer documentation

7 réponses

Votre réponse

Discussions similaires