visual studio - Commentaire XML .Net dans la documentation de l'API

Translate

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 croiser les yeux. Soit je manquais quelque chose d'important dans le processus, soit il est tout simplement trop compliqué.

Je sais que quelqu'un a une solution vraiment sympa et simple.

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

J'ai essayé Sandcastle mais j'ai eu du mal à le mettre en place. Ce que j'ai vraiment à l'esprit, c'est quelque chose de beaucoup plus simple.

Autrement dit, à moins que je ne comprends tout simplement pas le processus du château de sable. Cela m'a semblé être un énorme bagage supplémentaire juste pour produire quelque chose de sympa pour les testeurs.

This question and all comments follow the "Attribution Required."

Toutes les réponses

Translate

Vous recherchez Sandcastle

Page du projet:Communiqués de Sandcastle

Blog:Blog de Sandcastle

Générateur de documentation de code NDoc pour .NETAuparavant, c'était l'outil de choix, mais le support a pratiquement cessé.

La source
Translate

Jettes un coup d'oeil àChâteau de sable, qui fait exactement cela. C'est aussi 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 la configuration?

La source
Translate

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

La source
Translate

Suivrecet article simple en 5 étapeset vous avez pratiquement terminé. En prime, vous pouvez utiliserH2Viewerpour afficher les fichiers 2.x d'aide Html.

La source
Translate

Je viens de reconstituer 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 assemblage ou vos assemblys, ajoutez tous les fichiers de documentation .xml (ceux générés par le compilateur si vous avez activé cette option), puis Générer.

Cela prendra du temps, mais le résultatvolontévaut la peine. Il recherchera en fait des éléments de MSDN, de sorte que 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 lorsque vous voulez l'utiliser dans une construction automatisée, mais je suis absolument sûr que cela en vaudra la peine.

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

La source
Translate

j'utiliseNDoc3

La source