Commentaire XML .Net dans la documentation de l'API

Question

Existe-t-il un moyen simple de produire une documentation de style MSDN à partir de la sortie XML de Visual Studio ?
Je ne suis pas assez patient pour mettre en place un bon xslt car je sais que je ne suis pas la première personne à traverser ce pont.

De plus, j'ai récemment essayé d'installer un château de sable, mais cela m'a vraiment fait loucher.Soit il me manquait quelque chose d'important dans le processus, soit c'est tout simplement trop complexe.

Je sais que quelqu'un a une solution très simple et très intéressante.

Je le répète ici parce que je pense que ma mise en forme a rendu ce paragraphe non invitant à lire :

J'ai essayé Sandcastle mais j'ai eu beaucoup de mal à l'installer.Ce que j’ai vraiment en tête, c’est quelque chose de beaucoup plus simple.

Autrement dit, à moins que je ne comprenne tout simplement pas le processus du château de sable.Cela me semblait être un énorme bagage supplémentaire juste pour produire quelque chose d'agréable avec lequel les testeurs pourraient travailler.

Answer 1

Vous recherchez Château de Sable

Page du projet : Sorties de château de sable

Blog: Blog des châteaux de sable

Générateur de documentation de code NDoc pour .NET était autrefois l’outil de choix, mais le soutien a pratiquement cessé.

Answer 2

Jettes un coup d'oeil à Château de sable, ce qui fait exactement cela.C'est également l'une des solutions les plus simples du marché, 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 ?

Answer 3

Vous devez également utiliser le générateur de fichiers d'aide Sandcastle.Il vous fournit un ndoc comme une interface graphique 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 de création de fichiers d'aide Sandcastle

Answer 4

Suivre cet article simple en 5 étapes et vous avez pratiquement terminé.En bonus, vous pouvez utiliser H2Viewer pour afficher les fichiers d'aide HTML 2.x.

Answer 5

Je viens de réinstaller Sandcastle.Essayez de l'installer (la version de mai 2008) et recherchez SandcastleGui.exe ou quelque chose de similaire (il se trouve dans le dossier des exemples).

Cliquez sur Ajouter un assemblage et ajoutez votre ou vos assemblages, ajoutez tous 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 volonté ça en vaut la peine.Il recherchera en fait des éléments sur MSDN, de sorte que votre documentation résultante aura également l'héritage de classe jusqu'à System.Object avec des liens vers MSDN et autres.

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

Jetez également un oeil à Générateur de fichiers d'aide Sandcastle, il s'agit d'une interface graphique un peu plus avancée.

Answer 6

j'utilise NDoc3