commentaire XML .Net dans API Documentation

voix
15

Y at - il un moyen facile de produire des documents de style MSDN à partir de la sortie XML Visual Studio?
Je suis patient ne suffit pas de mettre en place un bon xslt pour elle parce que je sais que je ne suis pas la première personne à traverser ce pont.

En outre, j'ai essayé la mise en place Sandcastle récemment, mais il a vraiment fait mes yeux croix. Soit je manque quelque chose d'important dans le processus ou il est juste trop impliqué.

Je sais que quelqu'un là-bas a une très belle solution morte simple.

Je réitérant ici parce que je pense que mon formatage fait que le paragraphe non invitant à lire:

J'ai donné Sandcastle un essai mais a eu vraiment du mal à l'obtenir mis en place. Ce que j'ai vraiment à l'esprit est quelque chose de beaucoup plus simple.

Autrement dit, à moins que je ne comprends pas le processus Sandcastle. Il semblait un très grand nombre de bagages supplémentaire pour moi juste pour produire quelque chose de gentil pour les testeurs de travailler avec.

Créé 03/08/2008 à 23:03
source utilisateur
Dans d'autres langues...                            


6 réponses

voix
9

Vous êtes à la recherche Sandcastle

Page du projet: Communiqués de Sandcastle

Blog: Blog Sandcastle

Code de NDoc générateur de documentation pour .NET utilisé comme l'outil de choix, mais le soutien a pratiquement cessé.

Créé 03/08/2008 à 23:12
source utilisateur

voix
5

Vous devez également utiliser le Sandcastle Help File Builder. Il vous fournit un ndoc comme interface graphique pour générer des fichiers d'aide afin que vous ne devez pas faire quoi que ce soit à partir d'une invite de commande.

Bienvenue à l'aide Sandcastle Project Builder File

Créé 19/09/2008 à 16:22
source utilisateur

voix
5

Jetez un oeil à Sandcastle , qui fait exactement cela. Il est également l' une des solutions plus simples là - bas, et il est plus ou moins l'outil de choix, donc à long terme, nous pourrions peut - être vous aider à mettre en place Sandcastle si vous indiquez ce que vous les problèmes rencontrés lors de l' installation?

Créé 03/08/2008 à 23:14
source utilisateur

voix
3

Suivre cet article simple , en 5 étapes et vous êtes assez bien fait. En bonus , vous pouvez utiliser H2Viewer pour afficher les fichiers HTML Help 2.x.

Créé 04/08/2008 à 11:31
source utilisateur

voix
3

Je viens mis en place Sandcastle à nouveau. Essayez de l'installer (mai 2008 version) et la recherche de SandcastleGui.exe ou quelque chose de similaire (il est dans les exemples dossier ou si).

Cliquez sur Ajouter Assemblée et ajoutez votre Assemblée ou assemblées, ajouter des fichiers de documentation .xml (ceux générés par le compilateur si vous avez activé cette option) puis construire.

Il faudra un certain temps, mais le résultat sera en vaut la peine. Il regardera réellement des choses à partir de MSDN, de sorte que votre documentation qui en résulte aura également l'héritage de classe tout le chemin 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 automatique, mais je suis absolument sûr que ce sera en vaut la peine.

Aussi jeter un oeil à Sandcastle Help File Builder , c'est une interface graphique un peu plus avancé pour elle.

Créé 04/08/2008 à 11:27
source utilisateur

voix
2

J'utilise NDoc3

Créé 21/02/2010 à 23:12
source utilisateur

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more