Learn how to a build a cloud-first strategyRegister Now

x
?
Solved

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

Posted on 2008-11-14
2
Medium Priority
?
5,459 Views
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!)?

0
Comment
Question by:Cognize
2 Comments
 
LVL 19

Accepted Solution

by:
drichards earned 2000 total points
ID: 22965978
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.
0
 
LVL 2

Author Closing Comment

by:Cognize
ID: 31516740
Thanks very much for your help. I'll try those
0

Featured Post

Windows Server 2016: All you need to know

Learn about Hyper-V features that increase functionality and usability of Microsoft Windows Server 2016. Also, throughout this eBook, you’ll find some basic PowerShell examples that will help you leverage the scripts in your environments!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

It seems a simple enough task, yet I see repeated questions asking how to do it: how to pass data between two forms. In this article, I will show you the different mechanisms available for you to do just that. This article is directed towards the .N…
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…
Is your data getting by on basic protection measures? In today’s climate of debilitating malware and ransomware—like WannaCry—that may not be enough. You need to establish more than basics, like a recovery plan that protects both data and endpoints.…
Is your OST file inaccessible, Need to transfer OST file from one computer to another? Want to convert OST file to PST? If the answer to any of the above question is yes, then look no further. With the help of Stellar OST to PST Converter, you can e…
Suggested Courses
Course of the Month20 days, 22 hours left to enroll

810 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