Discussion :

[lutecefalco]

Bonjour tout le monde

Je suis en train de tester différents tools pour générer de la doc.
Après avoir testé NDoc, je suis en train de tester SandCastle/DocProject.

J'ai créé un projet DocProject, j'ai ajouté le projet que je veux documenter et je lance le build.
Tout va bien, pas d'erreur mais le dossier Help/Html reste désespérément vide.

Qq'un utilise ce tool ici?

Merci

[SaumonAgile]

Bonjour tout le monde

Je suis en train de tester différents tools pour générer de la doc.
Après avoir testé NDoc, je suis en train de tester SandCastle/DocProject.

J'ai créé un projet DocProject, j'ai ajouté le projet que je veux documenter et je lance le build.
Tout va bien, pas d'erreur mais le dossier Help/Html reste désespérément vide.

Qq'un utilise ce tool ici?

Merci

Perso j'utilise, SandCastle avec SandCastle Help File Builder. ça permet d'utiliser Sandcastle avec la même interface que NDoc.

Tu devrais ptêtre jeter un oeil sur cette solution.

[Philippe Vialatte]

Perso j'utilise, SandCastle avec SandCastle Help File Builder. ça permet d'utiliser Sandcastle avec la même interface que NDoc.

Tu devrais ptêtre jeter un oeil sur cette solution.

Pareil pour moi, jettes un oeil sur:

http://www.codeplex.com/SHFB

et, pour un tuto, sur :
http://bloggingabout.net/blogs/jschr...ly-mature.aspx


Par contre, ca rame un peu (1 minute/1 minute 30 par generation...)

[lutecefalco]

Téléchargé et installé
Je vais lire le tuto car je vois pas trop quoi faire après

[lutecefalco]

Bon, j'ai un ptit problème.

Ma solution contient plusieurs projets et moi je veux en documenter qu'un seul.
Mais comme ce projet à lier à d'autres, il me demande le.dll et le .xml pour chacun d'entre eux.
Comment on fait pour ne documenter que le projet qui m'intéresse?

[SaumonAgile]

Bon, j'ai un ptit problème.

Ma solution contient plusieurs projets et moi je veux en documenter qu'un seul.
Mais comme ce projet à lier à d'autres, il me demande le.dll et le .xml pour chacun d'entre eux.
Comment on fait pour ne documenter que le projet qui m'intéresse?

Et si tu réponds "non" quand il te demande le chemin vers les autres dll, il te dit quoi ?

[lutecefalco]

A la génération:

Info: Loaded 3 assemblies for reflection and 0 dependency assemblies.
Error: Unresolved assembly reference: Tools (Tools, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null) required by ValoEMTN.Business.Messages
Last step completed in 00:00:00.8750

[Promeneur]

Je ne sais pas si cela va t'aider, j'ai eu la même erreur, je l'ai corrigée grâce à une réponse dans le fichier d'aide, section FAQ :

Why does my build fail with an Unresolved assembly reference error?
If the build fails in the Generating reflection information step with an error that starts "Error: Unresolved assembly reference", you need to add the named assembly as a dependency. This is done by adding a reference to it using the Dependencies project property. See the Dependencies Property help topic for more information on adding dependency items. See the next question as well if you are documenting a Compact Framework application

Bref, il a fallu que j'aille dans Dependencies, et que j'ajoute le fichier qu'il ne trouvait pas.

[lutecefalco]

Je l'ai fait sauf que cette assembly n'est pas documenté et il se plaint encore car il ne trouve pas le .xml
Je vais essayer en lui mettant un .xml vide

[olivier34]

Bonjour,

Quels sont vos avis sur DocProject par rapport à Sandcastle Help File Builder, comme outillage pour générer de la documentation ?

J'ai testé l'outil Sandcastle avec SHFB. Cela fonctionne plutôt bien. DocProject apporte-t'il un mieux ?

Également en complément, Doxygen fonctionne lui aussi très bien sur du C# (avec un fonctionnement différent que Sandcastle, puisque basé sur le code source).

Olivier.

[Philippe Vialatte]

Salut,

je n'ai pas teste DocProject...pour etre honnete, j'ai mis tous les projets de la boite sur sandcastle avec shfb, et j'ai la flemme de tout re-faire...d'autant que, a priori, je ne vois pas de grosse grosse amélioration pour docproject par rapport a shfb...(au final, on genere la meme chose...)

entre-temps (parce que c'est un thread qui revient d'entre les morts), j'avais fait un petit tuto sur shfb, si ca t'interesse...

http://philippe.developpez.com/articles/SandCastle


Pour Doxygen, je n'ai pas approfondi non plus, car le resultat me semble plutot moins bon qu'avec sandcastle, donc...

[olivier34]

c'est un thread qui revient d'entre les morts

Vive l'indexation et les moteurs de recherches...

Effectivement, si le produit convient, pas de raison de tout reprendre pour peu (ou pas de valeur ajoutée.

Doxygen a l'avantage d'être universel... enfin multi-langages !