Générer la documentation technique automatiquement

**unix27** · 05/10/2009, 19h21

Bonjour, je suis entrain de définir des interface,classes,méthodes
et j'écris tous ce la dans des fichiers *.CS bien sûr donc je souhaiterai savoir ce qu'il faut faire ou inclure dans mon code qui me permettra de générer tous mon travail (classes,interface,méthode) automatiquement ... sans que je crée un fichier *.doc et je commence a refaire le travail que je fais maintenant
J'espère que j'ai étais clair et merci d'avance pour vos réponses

**bacelar** · 05/10/2009, 19h30

Sandcastle
http://www.codeplex.com/Sandcastle

**olibara** · 05/10/2009, 19h49

Je pense que la premiere chose a faire avant de penser a ta doc "externe" c'est déja d'avoir une bonne documentation "interne", c'est celle qui servira le plus !!
De meme que la plupart du temps un joli manuel ne sera pas souvent lu et n'aidera pas beaucoup a comprendre une interface mal foutue !

As tu remarqué par exemple que si tu tappe trois /// successif au dessus d'une methode le GUI te genere automatiquement un corps de description

**unix27** · 05/10/2009, 19h59

Envoyé par bacelar

Sandcastle
http://www.codeplex.com/Sandcastle

Merci je vais voir

Je pense que la premiere chose a faire avant de penser a ta doc "externe" c'est déja d'avoir une bonne documentation "interne", c'est celle qui servira le plus !!
De meme que la plupart du temps un joli manuel ne sera pas souvent lu et n'aidera pas beaucoup a comprendre une interface mal foutue !

As tu remarqué par exemple que si tu tappe trois /// successif au dessus d'une methode le GUI te genere automatiquement un corps de description

D'accord et après comment on fait pour exploiter c'est /// ??

**bacelar** · 05/10/2009, 20h01

C'est totomatique avec les outils comme SendCastle.

C'est comme JavaDoc en Java.

**olibara** · 05/10/2009, 20h55

Tu a aussi ce lien ci

http://www.developpez.net/forums/d38...e-code-csharp/

**Philippe Vialatte** · 06/10/2009, 10h38

Ou pour sandcastle :
http://philippe.developpez.com/articles/SandCastle/

Mais bon, je plussoies, si tu comptes utiliser SandCastle ou autre pour te passer d'ecrire la doc, tu vas dans le mur

, ce qui est interessant, c'est souvent plus la doc fonctionelle que la doc technique