mars
2007
Un article de dev01
Vous avez peut être rencontré le problème : Je veux générer la documentation pour mes projets .NET 2.0 et 3.0 . OR NDoc qui fait ça très bien pour 1.1 et a peu près pour 2.0 ne semble plus évoluer ce qui est très dommage …
Je me suis donc penché sur l’utilisation de Sandcastle, l’outil que Microsoft a développé pour dotnet.
Mais autant le dire tout de suite : son utilisation est loin d’être triviale …
La première chose que l’on remarque c’est que le programme n’est pas un programme mais 3 différents et tous en ligne de commande. Et quand on regarde l’exemple c’est clair faut être fou pour vouloir s’en servir …
Mais je suis quelqu’un de persistant, j’ai donc commencé à jouer en ligne de commande avec. Premiere commande : plantage du programme : « Impossible de résoudre une dépendence du projet : System.Configuration » … Euh ??? Comment ça tu trouves pas System.Configuration … La j’ai laissé tomber … j’ai cherché une interface graphique .
je suis tombé sur ce site : SandcastleDoc.com
Le premier de la liste ne fonctionne pas chez moi (une erreur obscure de fichier déjà utilisé par le process … )
Par contre le deuxième bien que assez dépouillé au niveau des options fonctionne parfaitement. Et c’est grâce à lui que j’ai compris d’ou vient le problème que j’ai rencontré avec le programme MRefBuilder : Il faut copier toute les dlls y compris celle du framework dans le dossier de l’assembly afin de satisfaire les dépendances ! Espérons que ce genre d’abération sera corrigé dans la version finale de sandcastle.
Sinon la doc généré est très bien et fait très pro vu que c’est le même template que celle de la msdn library 
7 Commentaires + Ajouter un commentaire
Commentaires récents
Archives
- juillet 2012
- mars 2012
- février 2012
- novembre 2011
- octobre 2011
- mars 2011
- novembre 2010
- octobre 2010
- septembre 2010
- août 2010
- avril 2010
- février 2010
- janvier 2010
- novembre 2009
- octobre 2009
- septembre 2009
- juin 2009
- mai 2009
- avril 2009
- mars 2009
- février 2009
- janvier 2009
- décembre 2008
- novembre 2008
- octobre 2008
- septembre 2008
- août 2008
- juin 2008
- mai 2008
- avril 2008
- février 2008
- mai 2007
- avril 2007
- mars 2007
- février 2007
- janvier 2007
alors il faut aller voir ici : http://vincentlaine.developpez.com/tuto/dotnet/comdoc/
Pour le lien, c’est le résultat fini, je voulais voir à quoi cela ressemble dans le code. En Java, on a les tags Javadoc, mais en dotnet, je ne vois pas ce qu’il y a….
Et non MS ne fourni pas dans le sdk de quoi faire générer la documentation. le compilateur C# sais extraire la documentation du code dans des fichiers xml mais il faut ensuite les tranformer en ce que l’on veux.
Pour ce qui est du lien, il est dans le commentaire au dessus du tiens
Microsoft ne fournit pas, dans le kit de développement, d’outil officiel pour la génération de la documentation des projets ?!?!
Est-ce qu’il y a un lien pour voir à quoi doit ressembler la documentation dans le code ?
En tout cas le nom du projet n’est pas rassurant….
Ben perso je trouve le résultat pas mal du tout :
un petit test
vous lui reprochez quoi à sandcastle a part qu’il est pas du tout simple à utiliser et qu’il faut copier la totalité des dll du fx dans le rep de l’application :aie:
j’avais commencé à écrire un tuto la dessus y’a quelques semaines mais la ligne de commande … pfiou, j’en ai été dégouté
puis meme avec une GUI, j’ai pas trouvé que le résultat final était super … encore des progrès à faire
j’ai aussi essayé de me servir de sendcaste en CTP il y a 4 mois et je n’ai pas été du tt convaincu, j’espère que la version définitive sera plus au point.
++