How to you auto generate code documentation from XML comments in Visual Studio 2008?

Posted on 2008-11-14
Last Modified: 2013-11-26
How to you auto generate code documentation from XML comments in Visual Studio 2008?

I've had a look at sandcastle, but it's a bit complicated to use, and I was sure that I've seen visual studio do this before anyway??

Does any one know how (preferably without redirecting me to one of MSDN's essays!)?

Question by:Cognize
    LVL 19

    Accepted Solution

    Visual Studio does not really produce documentation.  It will create XML documents from the comments, but you need to transform the XML into something that's actually usable as documentation.  There are a number of folks with transforms you can use, or you can get a tool like NDoc or DOxygen.  NDoc, I believe, uses the XML output while Doxygen goes directly against the source files.  Sandcastle does a lot of work by reflecting the assemblies (I think NDoc might do some of that, too) and, according to MS, optionally integrates the XML documentation comments.

    To generate the XML output from Visual Studio, you go to the Build tab in the project properties and check the "XML documentation file" box.
    LVL 2

    Author Closing Comment

    Thanks very much for your help. I'll try those

    Featured Post

    How your wiki can always stay up-to-date

    Quip doubles as a “living” wiki and a project management tool that evolves with your organization. As you finish projects in Quip, the work remains, easily accessible to all team members, new and old.
    - Increase transparency
    - Onboard new hires faster
    - Access from mobile/offline

    Join & Write a Comment

    This document covers how to connect to SQL Server and browse its contents.  It is meant for those new to Visual Studio and/or working with Microsoft SQL Server.  It is not a guide to building SQL Server database connections in your code.  This is mo…
    More often than not, we developers are confronted with a need: a need to make some kind of magic happen via code. Whether it is for a client, for the boss, or for our own personal projects, the need must be satisfied. Most of the time, the Framework…
    Migrating to Microsoft Office 365 is becoming increasingly popular for organizations both large and small. If you have made the leap to Microsoft’s cloud platform, you know that you will need to create a corporate email signature for your Office 365…
    Access reports are powerful and flexible. Learn how to create a query and then a grouped report using the wizard. Modify the report design after the wizard is done to make it look better. There will be another video to explain how to put the final p…

    732 members asked questions and received personalized solutions in the past 7 days.

    Join the community of 500,000 technology professionals and ask your questions.

    Join & Ask a Question

    Need Help in Real-Time?

    Connect with top rated Experts

    19 Experts available now in Live!

    Get 1:1 Help Now