Récupérer la doc du code pendant l'exécution du programmeRésolu

Question

Bonjour, Je voudrais savoir si pendant l'exécution de mon programme il est possible de récupérer la doc d'une méthode, celle qu'on ajoute dans le code source... Par exemple, dans mon code source j'ai ça : ///

/// Tools functions ///

public static class ClsTools { ... } J'aimerai arriver à récupérer le texte d'aide, pour n'importe quel élément documentable. Si quelqu'un a une idée, je suis preneur Merci d'avance Dédé

sebmafate · Accepted Answer

ce n'est pas possible... la documentation XML n'est pas compilée.

Par contre, tu peux utiliser l'attribut [Description("blabla")] et là ce sera possible... 

Sébastien FERRAND (blog)
Consultant Indépendant
[Microsoft Visual C# MVP]

billou_13 · Answer

Bonjour,

Je profites de l'occasion pour vous demander s'il existait un logiciel permettant de rendre un peu plus lisible la documentation xml générée à la compilation du projet.

J'avais vu le logiciel NDoc mais apparement pas de version pour le framework 2.0.
Existe-t-il un autre logiciel ?

Merci et bonne journée

maitredede · Answer

@seb : Cool, merci... Ca m'apprendra à croire à la petite souris...

@billou : Sandcastle : c'est l'outils de Microsoft qui te génère la doc... Sauf que son interface graphique est moche : yen a pas... J'ai rajouté une GUI qui s'appelle Sandcastle Help File Builder qui marche nickel avec. Ca te donnera une première piste.

sebmafate · Answer

Il existe un projet Microsoft qui s'appelle SandCastle... mais encore en beta.

Sébastien FERRAND (blog)
Consultant Indépendant
[Microsoft Visual C# MVP]

billou_13 · Answer

Merci beaucoup ^^

cs_coq · Answer

Salut, 

Concernant les projets reposant sur Sandcastle, on peut aussi citer : 
- SandcastleGUI
- DocProject

/*
coq
MVP Visual C#
CoqBlog
*/

bidou_01 · Answer

Bonsoir,

Hum j'utilise NDoc pour le framework 2.0 moi. D'ailleurs dommage que le projet ait été arrété !

Cordialement,

Bidou_01

billou_13 · Answer

Re,

Ayant tester avec SandCastle (& SandCastle Help File Builder) sans succès (une petite exception FileNotFountException sur un fichier prénommé '.xml' (bizarre comme fichier, je connaissais pas ^^. J'ai recherché une piste pour un NDoc fonctionnant (comme l'a annoncé bidou_01).

Je suis tomber sur NDoc 2.0 alpha disponible à l'adresse : http://kynosarges.de/NDoc.html. Il a marché nickel.

Je persévère pour tester SandCastle quand même ^^.

Affaire à suivre et merci à vous tous !!!

thristam · Answer

J'ai essayé les logiciels proposés. J'ai réussi à sortir de la doc .NET 2.0 qu'avec SandCastle Help File Builder. 

@bilou_13 : Peut-être que tu as oublié de lancer la réflection de .NET 2.0 en faisant demarrer > SHFB > Build Reflexion Data ( à faire en premier , dure au plus 30 minutes... ). Ensuite on ajoute le xml et l'assembly et ça créer un dossier Help contenant le Documentation.chm. 

J'ai essayé NDoc 2.0 alpha, ça m'a créer un dossier intellisense contenant juste le fichier xml du projet ... Tu peux me dire comment tu génères de la doc ?

@coq : SandleCastle GUI me parait compliqué à tous les niveaux. Déjà pour le télécharger il faut s'inscrire.... L'interface est trop compliquée. Par contre, Docproject a l'air sympa mais quand je charge un projet VS C# ça provoque une erreur. T'as réussi à générer de la doc avec ?

billou_13 · Answer

J'ai bien exécuté la réflexion avant mais cela ne marche pas mieux ^^

Concernant NDoc alpha, il suffit juste de change au niveau de la combobox au milieu de la fenêtre ^^

C'est tout !

Billou_13
Bask En Force 

--------------------------------------------------------------------
Connaître la réponse est une chose, savoir pourquoi en est une autre
---------------------

Récupérer la doc du code pendant l'exécution du programme

10 réponses

Votre réponse