Générer la Documentation de c# commentaires XML

Question

J'ai récemment commencé un nouveau projet et je suis à l'aide de C# pour la première fois. J'ai trouvé que, bien que Visual Studio est utile dans la création de C#'s XML commentaires pour documenter vos classes et de méthodes, il n'y a pas beaucoup que vous pouvez faire pour générer de MSDN ou la Javadoc de style de la documentation.

Google me dit que Visual Studio 2003 comprenait un outil pour générer la documentation, mais il n'est plus inclus dans les versions ultérieures de l'IDE.

Quelles sont mes options si je souhaite utiliser mes soigneusement conçu (je vous assure!) Balisage XML?

Answer 1

Merci pour les réponses, mais de Châteaux de sable semble un peu pénible à configurer et à utiliser, donc j'ai continué à regarder. Je viens de trouver une autre alternative - Doxygen.

Doxygen génère javadoc style de la documentation, même si on dirait qu'il est principalement destiné à produire de la documentation de la coutume de balisage dans vos commentaires. De toute évidence, Doxygen prend également en charge C#, XML Commentaires, bien que je ne trouve pas de mention sur leur site internet!

De toute façon, je le recommande. Il est facile à utiliser, prend en charge plusieurs langues, et génère des diagrammes de classe pour vous.

Answer 2

vous pouvez utiliser des châteaux pour faire.

certaines ressources sont: Château de sable:

• Château de sable
• Sandcastle Help File Builder - GUI
• DocProject pour les Châteaux de sable

Articles sur la documentation du code C#:

• Commentaires XML Vous permettent de Construire des Documents Directement à Partir de Visual Studio .NET Fichiers Source (sur MSDN Magazine)
• C# Documenter et Commenter (sur CodeProject)
• C# et XML Documentation du Code Source (sur CodeProject)
• C# Tutorial Leçon 19: La Documentation Dans Le Code

Answer 3

Puis-je suggérer humblement pour essayer ImmDoc.NET - un simple projet, j’ai développé quelques temps auparavant et récemment publié sur CodePlex. Il est léger, très facile à utiliser et prend en charge .NET 2.0.

Answer 4

@Portman : NDoc est mort et Sandcastle est peut-être le meilleur prochain (à être mort) Doxygen est si simple de l’utiliser directement « out of the box » est également très configurable.

Il dispose d’une interface graphique qui aide à la configuration et les essais pour le contenu de votre cœur, vous pouvez modifier.

Answer 5

Je suis content que vous avez trouvé la meilleure alternative - Doxygen ! J’utilise Doxygen pour C# .NET et il génère des diagrammes de classes, les diagrammes de l’héritage, etc.. Voici un post de blog informatif.