J'utilise Visual Studio 2010 et j'ai commencé à être un bon garçon et à documenter tout mon code comme je l'ai écrit, via XML Commentaires. J'ai un projet bien documenté et j'ai même compris comment rendre Visual Studio cracher un document XML complet lors de la construction. Ma question est de savoir quelle est la meilleure façon de formater / afficher ce document sur le Web afin qu'il apparaisse dans un bon format convivial et utilisable comme MSDN? Y a-t-il un outil qui le fait facilement?
Merci d'avance!
5 Réponses :
Vérifiez Sandcastle .
Sandcastle produit une documentation complète, de style MSDN, en réfléchissant sur les ensembles source et en intégrant éventuellement des commentaires de la documentation XML.
Wikipedia dispose de plus d'informations et de liens vers des projets supplémentaires qui s'intègrent à Sandcastle. < / p>
Une autre option (qui semble être beaucoup plus facile à utiliser) est Docu :
Un générateur de documentation pour .NET qui n'est pas compliqué, maladroit ou difficile à utiliser. Compte tenu d'un assemblage et du XML généré par Visual Studio, Docu peut produire un site Web complet de la documentation avec une seule commande.
Une troisième option est NDoc :
NDOC génère une documentation de la bibliothèque de classe à partir d'assemblages .NET et des fichiers de documentation XML générés par le compilateur C # (ou avec un outil complémentaire pour vb.net).
NDOC utilise des documentateurs Pluggable pour générer de la documentation dans plusieurs formats différents, y compris le format d'aide HTML de style MSDN (.chm), le format d'aide Visual Studio .NET (HTML Aide 2) et les pages Web de style en ligne MSDN. < / p>
C'est drôle, c'est le premier que j'ai rencontré. Cela semblait plutôt encombrant. Je ne pense pas que cela se lit chez le document XML généré, il se lit auprès des fichiers .Cs. C'est une option à coup sûr, mais j'aimerais voir si quelqu'un d'autre a d'autres options à mettre en avant.
@Chevex - Ce fut le roi depuis des années ... J'ai mis à jour ma réponse avec une autre option.
Je veux utiliser Sandcastle mais ça me déroure un peu. Je l'ai installé mais je n'ai rien clair là où il est allé. At-il une interface graphique?
@Chevex - il est notoirement difficile à utiliser. Voir les autres options que j'ai ajoutées. Docu ressemble à un bon.
Docu génère une erreur chaque fois que j'essaie de l'utiliser, malheureusement. Il dit qu'il a rencontré un point d'arrêt défini par l'utilisateur. Cependant, c'est possible.
J'aimerais pouvoir trouver un bon tutoriel imbécile pour utiliser Sandcastle. Il est installé et je n'ai toujours aucune idée de l'accès à ses options.
NDoc est également une option. Mais j'irais avec le château de sable et c'était ce que j'ai fait.
Consultez Sandcastle Aide Fichier Builder . Ceci est un outil d'interface graphique qui rend Sandcastle assez facile à travailler. Il s'installera dans un dossier dans Démarrer Menu-> Fichiers de programme-> Sandcastle Aide File Builder.; C'est assez facile à utiliser, mais ce n'est pas incroyablement rapide.
espère que cela aide!
J'ai réussi à obtenir cela pour créer une documentation lors de l'événement de construction de Visual Studio. Consultez ma réponse sur cette question: Stackoverflow.com/Questtions/211693/...
J'ai créé un projet open source pour les exposer dans les pages Web Check @ AutoHelp
AutoHelP lit les fichiers DLL & XML DOC, génère des pages d'aide et les expose aux utilisateurs. AutoHelp utilise ASP.NET MVC 5, ASP.NET WebAPI, TypeScript, JQuery et Bootstrap pour être une application Web moderne.
Semble prometteur mais aucune activité au cours des 4 dernières années.
en 2020, vous voulez probablement aller avec DOXYGEN . Fonctionne comme un charme pour mon projet de base .NET.
DOXYGEN est l'outil Standard de facto pour générer de la documentation à partir de sources annotées C ++, mais elle prend également en charge d'autres langages de programmation populaires tels que C, Objective-C, C #, PHP, Java, Python, IDL (Corba, Microsoft et Uno / OpenOffice Saveurs), Fortran, VHDL et dans une certaine mesure d.
DOXYGEN peut exporter vers HTML, latex, RTF (MS-Word), PostScript, PDF hyperliend, HTML compressé et UNIX Man. La documentation est extraite directement des sources.
duplicaté possible de Visual Studio avoir une option pour générer une documentation HTML pour les commentaires de style Javadoc?