C# xml documentation

Question

What's the purpose of the .xml documentation files shipped with the assemblies (.dll files).

I know, how to build a one (as here, for example), but what can they be used for?

Also, if this documentation can be integrated into the MS Visual Studio environment, how should that be done?

SLaks · Accepted Answer · 2010-12-05 00:04:06Z

12

If you put the XML file in the same folder as the DLL, Visual Studio will show descriptions in IntelliSense. (including parameter tooltips)

answered Dec 5, 2010 at 0:04

SLaks

891k182 gold badges1.9k silver badges2k bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Devendra D. Chavan · Accepted Answer · 2010-12-05 03:23:10Z

5

Using the xml documentation with the recommended tags greatly improves the readability of code when they are used by external classes.

Also, you can generate a help document from the xml comments using tools like Sandcastle. This tool generates a chm file that is very similar to the documentation that you see on msdn for .NET classes.

As for the integration into Visual Studio environment, it is done automatically and happens as soon as you build you project. While using the documented class / method / property, the Intellisense feature shows the xml comments.

In addition, free Visual Studio tools like Ghost Doc (from SubMain) allow you to generate most of the tags simply by using key board shortcuts!

answered Dec 5, 2010 at 3:23

Devendra D. Chavan

9,0314 gold badges35 silver badges35 bronze badges

Collectives™ on Stack Overflow

C# xml documentation

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related