Discussion :

[guilig]

Bonjour à tous,
Je ne sais pas si ce post est à la bonne place, excusez-moi dans le cas contraire.
J'aimerai savoir si il existait un programme pouvant générer de la documentation depuis un projet écrit en C#.
Le programme le plus connu est sans doute Ndoc mais il n'est pas compatible avec un projet en .Net 2.0.
Donc si quelqu'un connait le moyen de générer de la documentation depuis un programme externe à VS2005 ou sait avec quoi exploiter le fichier xl générer depuis cet IDE pour faire une jolie petite doc, je suis preneur.

Merci d'avance pour votre aide.

[theMonz31]

j'ai utilisé il y a bien longtemps "Doxygen"... maintenant, je ne saurais te repondre sur son utilisation en C#....

Mais bon.... ca peut surement se regarder

The Monz, Toulouse

[m-mas]

Bonjour à tous,
Je ne sais pas si ce post est à la bonne place, excusez-moi dans le cas contraire.
J'aimerai savoir si il existait un programme pouvant générer de la documentation depuis un projet écrit en C#.
Le programme le plus connu est sans doute Ndoc mais il n'est pas compatible avec un projet en .Net 2.0.
Donc si quelqu'un connait le moyen de générer de la documentation depuis un programme externe à VS2005 ou sait avec quoi exploiter le fichier xl générer depuis cet IDE pour faire une jolie petite doc, je suis preneur.

Merci d'avance pour votre aide.

il y a NDoc 2005 pour le framework 2.0 !

[guilig]

Merci pour l'info, je ne connaissais pas.
Vissiblement la release n'est pas sortie, du coup ca plante pas mal, impossible de générer quoique ce soit :
Exception: System.Exception

Error compiling the assembly stylesheet



Exception: System.IO.DirectoryNotFoundException

Impossible de trouver une partie du chemin d'accès 'D:\Documenter\Intellisense\xslt\assembly.xslt'.




Dommage.
Je vois pas trop comment m'en sortir, et j'ai pas trop le temps de me pencher sur les sources.

[Capitaine Kirk]

Bonsoir

guilig, tu peux essayer l'outil qui se trouve ici Back to NDoc

Capitaine Kirk.

[guilig]

Merci Capitaine Kirk,

Ca fonctionne nickel.

Un petit programme bien sympathique à conseiller pour du .NET 2.0

[m-mas]

oui je confirme ! ça marche bien !

Par contre, j'ai une solution contenant n projets (n=25 pour être précis), j'ai voulu documenter toute la solution, il m'indique qu'aucun projets de documentation ne peut être importé (There are no projects in this solution that NDoc can import.) pourtant si je choisi une dll d'un projet de ma solution, ça fonctionne, du coup je me trouve avec n fichiers .chm ce qui n'est pas trés pratique !

quelqu'un à t il une solution ?

Merci.

[Thomas Lebrun]

Rhalala, pour générer les documentations, pourquoi ne prenez-vous pas Sandcastle ?

http://www.microsoft.com/downloads/d...displaylang=en

[m-mas]

Rhalala, pour générer les documentations, pourquoi ne prenez-vous pas Sandcastle ?

http://www.microsoft.com/downloads/d...displaylang=en

je pense que Sandcastle est une usine à gaz (pour l'instant) car je suis pas arrivé à l'utiliser ! j'ai même trouvé une interface graphique qui facilite son utilisation http://www.softpedia.com/get/Program...astleGUI.shtml

bref, j'ai passé 3h à essayer de l'utiliser (en téléchargeant tout, chercher sur internet, lire la doc ...) je suis arrivé à rien ! avec des messages d'erreurs que je n'ai pas bien compris, je me suis du coup revenu au bon vieux Ndoc

sinon par ma question, il est bien évidement possible de sélectionner plusieurs Assemblies en utilisant le bouton "Add" à chaque fois !

[Aramis]

oui je confirme ! ça marche bien !

Par contre, j'ai une solution contenant n projets (n=25 pour être précis), j'ai voulu documenter toute la solution, il m'indique qu'aucun projets de documentation ne peut être importé (There are no projects in this solution that NDoc can import.) pourtant si je choisi une dll d'un projet de ma solution, ça fonctionne, du coup je me trouve avec n fichiers .chm ce qui n'est pas trés pratique !

quelqu'un à t il une solution ?

Merci.

Bonjour,

j'ai deja eu un probleme similaire avec NDoc, la solution est bien simple : il faut faire en sorte, et etre sure, que chaque projet genere une documentation XML et que celle-ci apparaisse dans le dossier Debug ou bien Release.

HTH,

Ar@mi$

[alicia1984]

Bonsoir

guilig, tu peux essayer l'outil qui se trouve ici Back to NDoc

Capitaine Kirk.

Bonjour tout le monde,

Je ne suis pas une pro en info et depuis hier je me bat pour trouver un outil qui me permette de générer de la doc pour un projet sous VS2005 en C#.

J'ai déjà essayé différente version de ndoc et sandcastle mais ça marche jamais

Je voudrai bien tester l'outil Back to NDoc mais quand je clique sur le lien, je ne trouve pas comment le télécharger ! C'est une question bête je sais, mais là je vois pas... C'est peut-être mon dernier espoir ! Alors si quelqu'un voulait bien m'éclairer, ça serait gentil Merci d'avance

Alicia

[dev01]

Rhalala, pour générer les documentations, pourquoi ne prenez-vous pas Sandcastle ?

http://www.microsoft.com/downloads/d...displaylang=en

Parce que Sandcastle est totalement inutilisable en l'état ....

Pour infos pour que sandcastle fonctionne il faut copier la totalité des dll du framework dotnet dans le répertoire de la doc afin qu'il arrive à éditer les référence ....

La façon que j'ai trouvé de l'utiliser c'est avec un GUI dont je ne me rappel pas le nom

[rattlehead]

cherche dans codeproject.com sandcaste. un mec a fait un super outil pour générer la doc.

[alicia1984]

merci beaucoup pour votre aide, ça marche !!!!! J'ai téléchargé Sandcastle Help File Builder et ça a enfin marché !

Youpi ma première doc

[seb8327]

Bonjour à tous,
En effet sandCastle est difficilement utilisable seul, et pour moi la meilleur interface pour cet outils est SandCastle Help File Builder.
En plus cet outils permet de customiser la génération de la documentation, par exemple sur DslFactory.org ils ont publié un addin à cet outil.

[Thomas Lebrun]

Parce que Sandcastle est totalement inutilisable en l'état ....

Bah, faut juste savoir l'utiliser

La façon que j'ai trouvé de l'utiliser c'est avec un GUI dont je ne me rappel pas le nom

Tu vois que c'est possible. C'est sur que si tu préfères tout faire en ligne de commandes aussi

[dev01]

Bah, faut juste savoir l'utiliser

ouais faut savoir qu'il faut copier la totalité des dll du Fx dans le rep de génération sinon ça marche ... . En plus de pas être pas être pratique, c'est carrément très moche comme façon de faire ... Pour un outil MS ils pourraient savoir ou sont les libs par défaut ....

Tu vois que c'est possible. C'est sur que si tu préfères tout faire en ligne de commandes aussi

Rien à voir entre la ligne de com ou le GUI. (Surtout que dans ce cas je dit que je prefere le GUI ... ).

[Thomas Lebrun]

Quoiqu'il en soit, SandCastle est tout à fait utilisable en l'état. Certes, la configuration est un peu ardue au début mais il suffit de bien lire la doc... Et puis, il ne faut pas oublier que c'est un produit toujours en version Beta.

Après, je n'ai jamais dit que c'était le meilleur outil: je parle juste de ce que je connais...

Il serait p-e bien d'avoir un article la-dessus (les diffiérents outils de génération de doc), je crois pas qu'on ait déjà quelque chose: un volontaire ?