Question Comment exporter la documentation du code dans C # / VisualStudio 2008?


J'ai toujours tenu à écrire des commentaires de code sympas pour les classes et les méthodes avec la syntaxe C # xml. Je m'attendais toujours à pouvoir les exporter plus tard.

Aujourd'hui, je dois le faire, mais j'ai du mal à trouver comment. Y a-t-il quelque chose qui me manque? Je veux aller Menu-> Build-> Build Code Documentation, mais il n'y a pas d'option pour le faire, là.


19
2017-09-09 12:53


origine


Réponses:


En fait, c'est dans les propriétés du projet. Créez l'onglet, la section Sortie, le fichier de documentation XML et entrez le nom du fichier. Il sera construit sur chaque construction du projet.

Après cela, vous pouvez créer l'aide réelle avec Château de sable.


24
2017-09-09 12:57



Tu pourrais essayer NDOC ou SandCastle Si cela ne vous dérange pas d'utiliser des outils tiers.


4
2017-09-09 12:56



Château de sable fonctionne assez bien pour générer de la documentation et prend en charge deux formats différents pour la génération. Pour autant que je sache, il n'y a pas d'intégration de Visual Studio pour cela, mais il y a un SandcastleGUI pour cela c'est disponible.


1
2017-09-09 13:00



Soyez prudent si vous utilisez LINQ to SQL, car vous ne pourrez pas ajouter facilement des commentaires durables aux objets générés automatiquement.


1
2017-09-09 13:56



Commentaire tardif, mais cela vaut la peine d’ajouter que même si Sandcastle est déconcerté, le Sandcastle Help File Builder reste en développement actif, et je l'ai trouvé très puissant et facile à comprendre lorsque vous avez dû faire face à cette situation - installez-le sur une sortie riche .chm et .html / .asp en quelques heures.


1
2018-04-02 16:49



Le projet NDoc original (mentionné par d’autres) est mort, mais il y a un nouveau projet appelé NDoc3.

NDoc3 prend en charge .NET 2.0 - 3.5. Il est actuellement disponible en version bêta et a très bien fonctionné pour moi. Je ne sais pas si le projet est toujours actif - la dernière version bêta a été publiée en avril 2009.


0
2017-10-23 13:31