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

Question

J'ai toujours mis un point d'honneur à écrire de jolis commentaires de code pour les classes et les méthodes avec la syntaxe XML C#.Je me suis toujours attendu à pouvoir les exporter facilement plus tard.

Aujourd'hui, je dois effectivement le faire, mais j'ai du mal à savoir comment.Y a-t-il quelque chose qui me manque ?Je veux y aller Menu->Construire->Documentation du code de construction, mais il n'y a aucune option pour le faire, là-bas.

Answer 1

En fait, c'est dans les propriétés du projet.Onglet Construction, section Sortie, fichier de documentation XML et entrez le nom du fichier.Il sera construit sur chaque build du projet.

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

Answer 2

Tu pourrais essayer NDOC ou Château de Sable si cela ne vous dérange pas d'utiliser des outils tiers.

Answer 3

Château de sable fonctionne plutôt bien pour générer de la documentation et prend en charge plusieurs formats différents pour la génération.Pour autant que je sache, il n'existe aucune intégration Visual Studio, mais il existe un Château de SableGUI pour cela qui est disponible.

Answer 4

Soyez prudent 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

Commentaire tardif, mais il convient d'ajouter que même si Sandcastle est mis en veilleuse, le Générateur de fichiers d'aide Sandcastle reste en développement actif, et je l'ai trouvé très puissant et simple à aborder face à cette situation : installer sur une sortie riche .chm et .html/.asp en quelques heures.

Answer 6

Le projet NDoc original (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 très bien fonctionné pour moi.Je ne sais pas si le projet est toujours actif – la dernière version bêta est sortie en avril 2009.