Discussion :

[alex_vino]

Bonjour,

Je souhaiterais savoir comment vous générez la documentation de vos programmes.

Je recherche un outil qui génère une aide HTML de type MSDN.
Soit il n'y a pas, soit ça ne fonctionne pas.
N'y a t'il qu'une génération des commentaires au format XML inexploitable ?

Sous Java la javadoc est si simple à générer, Visual Studio serait-il si compliqué pour une tâche si importante ?

[tomlev]

Il n'y a aucun outil fourni avec Visual Studio pour faire ça, ce que j'ai toujours trouvé aberrant...

Tu peux utiliser Doxygen, qui est assez simple, mais le format n'est pas du tout celui de la MSDN, et le support des dernières évolutions de C#/.NET n'est pas forcément très bon (genre méthodes d'extensions, propriétés attachées en WPF, etc)

Après, l'outil "officiel" proposé par Microsoft est Sandcastle, qui génère la doc au format MSDN (VS2005/2008, je suis pas sûr qu'il sache générer le format VS2010). C'est puissant, ça couvre à peu près tous les besoins... mais c'est une horreur à utiliser, vraiment très complexe. Heureusement il y a un outil qui fournit une GUI et facilite (un peu) la tâche : Sandcastle Help File Builder (nécessite d'avoir aussi installé Sandcastle). Tant que tu cherches pas à faire des choses compliquées, tu devrais pouvoir t'en sortir avec ça. Par contre c'est vite galère si tu veux sortir des sentiers battus (par exemple générer la doc en français, comme j'ai fait pour Dvp.NET)

[alex_vino]

Merci tomlev.

SandCastle répond enfin à mes attentes.

Merci aussi pour le lien Dvp.NET au passage que je connaissais pas, mais peux tu me dire comment tu fais pour générer sans les URL absolue de frame et éviter le message d'alerte sécurité Javascript ? Chrome ne fonctionne pas sinon.

Et j'ai une autre question, comment se fait t'il que quand je génère la doc de toute ma solution, certains projets sont ignorés ?

[tomlev]

peux tu me dire comment tu fais pour générer sans les URL absolue de frame et éviter le message d'alerte sécurité Javascript ? Chrome ne fonctionne pas sinon.

Euh... aucune idée. J'ai rien fait de spécial pour ça il me semble, et j'ai jamais vu d'alerte de sécurité JS (je peux pas tester avec Chrome au bureau, dans ma boite on n'a pas le droit de l'installer )

Et j'ai une autre question, comment se fait t'il que quand je génère la doc de toute ma solution, certains projets sont ignorés ?

Re-euh...
Tu es sûr que la case "générer la doc XML" est bien cochée dans tous les projets ?
Et dans Sandcastle, tu as bien ajouté toutes les DLL et tous les fichiers XML de doc ?