Commentaire XML .Net dans la documentation de l'API

Existe-t-il un moyen facile de produire la documentation de style MSDN à partir de la sortie xml Visual Studio? Je ne suis pas assez patient pour mettre en place un bon xslt car je sais que je ne suis pas le premier à franchir ce pont.

De plus, j'ai essayé de mettre en place un château de sable récemment, mais ça m'a vraiment fait traverser les yeux. Soit il me manquait quelque chose d'important dans le processus, soit il est trop impliqué.

Je sais que quelqu'un là-bas a une solution vraiment simple.

Je répète ici parce que je pense que mon formatage a rendu ce paragraphe non invitant à lire:

J'ai donné un essai à Sandcastle mais j'ai vraiment eu du mal à le mettre en place.   Ce que j'ai vraiment en tête est quelque chose de beaucoup plus simple.

C'est, à moins que je ne comprends tout simplement pas le processus de châteaux de sable. Cela m'a semblé énormément de bagage supplémentaire juste pour produire quelque chose de bien pour les testeurs.

0

6 Réponses

Suivez cet article simple en 5 étapes et vous avez à peu près terminé. En prime, vous pouvez utiliser H2Viewer pour afficher les fichiers Html Help 2.x.

0
ajouté

Jetez un oeil à Sandcastle , qui fait exactement cela. C'est aussi l'une des solutions les plus simples, et c'est plus ou moins l'outil de choix, donc à long terme, nous pourrions peut-être vous aider à configurer Sandcastle si vous spécifiez les problèmes que vous avez rencontrés lors de l'installation.

0
ajouté

Je viens de mettre en place Sandcastle à nouveau. Essayez de l'installer (la version de mai 2008) et recherchez SandcastleGui.exe ou quelque chose de similaire (c'est dans le dossier des exemples ou plus).

Cliquez sur Ajouter un assemblage et ajoutez votre assemblage ou vos assemblages, ajoutez les fichiers de documentation .xml (ceux générés par le compilateur si vous avez activé cette option), puis Build.

Cela prendra du temps, mais le résultat en vaudra la peine . Il cherchera réellement des choses de MSDN, ainsi votre documentation résultante aura également l'héritage de classe jusqu'à System.Object avec des liens vers MSDN et d'autres choses.

Sandcastle semble un peu compliqué au début, surtout quand vous voulez l'utiliser dans une construction automatisée, mais je suis absolument sûr que cela en vaudra la peine.

Consultez également Sandcastle Help File Builder , il s'agit d'une interface graphique un peu plus avancée.

0
ajouté

Vous recherchez Sandcastle

Project Page: Sandcastle Releases

Blog: Sandcastle Blog

NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.

0
ajouté
ajouté l'auteur Muxa, source

Vous devez également utiliser le Générateur de fichiers d'aide Sandcastle. Il vous fournit une interface graphique similaire à ndoc pour générer des fichiers d'aide afin que vous n'ayez rien à faire à partir d'une invite de commande.

Bienvenue dans le projet Sandcastle Help File Builder

0
ajouté

I use NDoc3

0
ajouté