1. Accueil
  2. Question et réponse
  3. Comment exporter la documentation du code dans C#/VisualStudio 2008?

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

2008-09-09 7 views
19

J'ai toujours pris soin d'écrire de jolis commentaires de code pour les classes et les méthodes avec la syntaxe C# xml. Je m'attendais toujours à pouvoir facilement les exporter plus tard.Comment exporter la documentation du code dans C#/VisualStudio 2008?

Aujourd'hui, je dois effectivement 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à.

Source

2008-09-09 Daren Thomas

+0

_OP avait ajouté cette suggestion: _ Ce lien a un xslt facile pour les exportations rapides et sales: http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx – Mogsdad

Répondre

24

En fait, c'est dans les propriétés du projet. Construire l'onglet, la section Sortie, le fichier de documentation XML et entrer le nom du fichier. Il sera construit sur chaque build du projet. Ensuite, vous pouvez créer l'aide réelle avec Sandcastle.

Source

2008-09-09 12:57:06 Biri

+0

Vous pouvez toujours écrire un XSL/XSLT pour formater le XML pour un résultat plus agréable. – Biri

4

Vous pouvez essayer NDOC ou SandCastle si cela ne vous dérange pas d'utiliser des outils tiers.

Source

2008-09-09 12:56:19

+0

Bien que ce lien puisse répondre à la question, il est préférable d'inclure ici les parties essentielles de la réponse et de fournir le lien pour référence. Les réponses à lien uniquement peuvent devenir invalides si la page liée change. - [De la revue] (/ review/low-quality-posts/18546091) – Nae

1

Sandcastle fonctionne assez bien pour générer de la documentation et il prend en charge plusieurs formats différents pour la génération. Pour autant que je sache, il n'y a aucune intégration de Visual Studio pour cela, mais il y a un SandcastleGUI pour cela qui est disponible.

Source

2008-09-09 13:00:23 rjzii

1

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

Source

2008-09-09 13:56:37

0

Le projet NDoc d'origine (mentionné par d'autres) est mort, mais il existe un nouveau projet appelé NDoc3. NDoc3 prend en charge .NET 2.0 - 3.5.

Il est actuellement disponible en version bêta et a bien fonctionné pour moi. Je ne suis pas sûr si le projet est toujours actif - la dernière version bêta a été publiée en avril 2009.

Source

2009-10-23 13:31:12 M4N

1

Dernier commentaire, mais il vaut la peine d'ajouter que même si Sandcastle est mis en veille, le Sandcastle Help File Builder reste en développement actif, et je l'ai trouvé très puissant et simple à plonger dans le traitement de cette situation - installez-vous à la sortie rich .chm et .html/.asp en quelques heures.

Source

2014-04-02 16:49:28 downwitch

Questions connexes

 Questions connexes