Générer des fichiers HTML / Aide de VS 2010 C # documentation XML

Question

Je cherche un bon outil de création de fichiers HTML / Aide de mon VS2010 documentation XML. J'ai trouvé des outils commerciaux tels que

• outil de documentation .Net
• VSdocman

Je suis sûr qu'il ya plus, je ne mentionner que ces deux exemples. De plus il y a de simples feuilles de style XSLT autour de convertir les données XML à la documentation HTML.

Qu'est-ce que vous utilisez, par exemple est-il un outil libre de faire la conversion, peut-être comme Add-In. Juste pour clarifier, au fond, j'ai trouvé deux types d'outils:

1. Ceux de conversion du fichier de documentation XML dans différents formats cibles, ce que je cherche.
2. Outils me aider à générer la documentation XML dans le code source. Ce n'est pas (!) Ce que je cherche.

Merci pour votre aide.

---

Le combo Sandcastle / SHFB fonctionne très bien. Merci à tous ceux qui ont aidé.

Quelques remarques:

1. NDoc semble être obsolète, dernières mises à jour sont à partir de 2005. Voilà pourquoi je l'ai sautées cela.
2. Vous trouverez un fil similaire, très détaillé, ici: https://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something-useful Merci pour l'astuce!
3. Il y a quelques sources pour Sandcastle, la dernière version que j'ai trouvé se trouve ici: http: //sandcastle.codeplex .com /
4. Afin de générer MsHelp2 je devais installer VS 2008 SDK contenant hscomp.exe. Il existe une version 1.0 et 1.1, pour autant que je pouvais le comprendre la version 1.0 contient le compilateur. Voir Helixsoft et MSDN social pour quelques détails.
5. Dans mon cas, le WebHelp généré ne fonctionne pas correctement avec Chrome. Il toujours la page recharge index.html.
6. Le montre comment ajouter infos espace de noms dans la documentation Sandcastle.
7. Mise à jour à partir de Nov 2012: Pour les petits projets que je suis en utilisant Doxygen - Je trouve un peu plus facile configurer.

Answer 1

Nous utilisons Sandcastle pour la transformation et Sandcastle Help File Builder comme une interface utilisateur pour gérer les projets d'aide. À mon avis, la beauté du Sandcastle et SHFB est, qu'à côté de la documentation du code source « moyenne », vous pouvez ajouter des informations supplémentaires comme l'architecture du programme, les modèles qui doivent être suivies ou tout autre contenu conceptionnelle supplémentaire pour votre projet non lié directement à une classe dans votre programme. Cela peut se faire en créant des fichiers xml supplémentaires avec l'aide de Microsoft Authoring schéma (peut être modifié avec le studio visuel que le fichier XML et le schéma pour elle sont disponibles). Son assez facile de commencer avec les deux outils pour la création de MSDN, comme la documentation.

Il y a longtemps que j'ai essayé DocBook qui est à peu près le même sur le plan technique (fichiers XML contenant les fichiers d'information et xslt pour le transformer en différents types de sortie). Mais il était pas d'autre choix pour nous, parce qu'il n'y a pas de transformation qui il peut utiliser le studio visuel généré la documentation xml (plus la transformation du contenu conceptuel était assez pénible pour nous).

Answer 2

Deux outils plus libres qui permettent la création de la documentation des commentaires Xml:

• NDoc
• Sandcastle

Answer 3

Sandcastle + SHFB are a great combo. Free and generates html, chm, etc