Existe-t-il un bon guide de démarrage rapide pour générer des documents API avec Sandcastle?

Question

Je vais générer des documents API à l'aide de Sandcastle - je ne pouvais trouver aucun guide sur la façon de le faire sur leur site Web. Quelqu'un a-t-il des guides de démarrage rapide à recommander?

Answer 1

Je suggérerais d'utiliser SHFB (si vous le pouvez), car cela facilite vraiment les choses. SHFB est livré avec une documentation, mais vous pourrez utiliser les fonctionnalités courantes sans tutoriel.

Answer 2

Je suis également un fervent partisan de SHFB , à tel point qu'en septembre 2010, j'ai écrit un article assez volumineux. sur Sandcastle et SHFB intitulé Taming Sandcastle: Le Guide du programmeur .NET pour la documentation de votre code décrit les astuces d'utilisation et les nombreux pièges potentiels que l'on risque de rencontrer. En effet, en octobre 2010, nous avons suivi "> Tableau mural d'une page qui résume le lexique de commentaire de la documentation XML pour SHFB.

De mes recherches pour l'article, voici une liste complète d'autres ressources utiles:

Documentation sur le générateur de fichiers d'aide de Sandcastle (créateur de fichier SHFB) Eric Woodruff / li>
• Guide de programmation C #: Balises recommandées pour les commentaires dans la documentation (MSDN)
• Wm. Le Guide de commentaires de la documentation XML d’Eric (Dynicity)
• La documentation XML en C # d'Anson Horton; Gestionnaire de programme)

Answer 3

Peut-être pourriez-vous consulter le site (codeplex) de SandCastle . Mais selon mon expérience, il est préférable de jouer avec. La première chose à faire est de configurer votre application pour générer vos commentaires dans un fichier XML (et à l’aide de commentaires XML dans votre code). Ceci est un paramètre de votre projet.

Vous pouvez ensuite charger votre assemblage avec le code XML associé dans Sandcastle et jouer avec les paramètres (dans la plupart des cas, les paramètres par défaut sont suffisants). La plupart des paramètres sont auto-documentés ou sont évidents en regardant le nom.

Bonne chance à jouer avec!