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

Question

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.

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à.

Answer 1

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.

Answer 2

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

Answer 3

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.

Answer 4

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.

Answer 5

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.

Answer 6

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.