Home Library Learn Downloads Support Community
Sign in | United States - English | |
9 out of 107 rated this helpful - Rate this topic

XML Documentation Comments (C# Programming Guide)

Visual Studio 2005

In Visual C# you can create documentation for your code by including XML tags in special comment fields in your source code directly before the code block they refer to. For example:

Copy 
/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

When you compile with /doc the compiler will search for all XML tags in your source code and create an XML documentation file.

NoteNote

The XML doc comments are not metadata; they are not included in the compiled assembly and therefore they are not accessible through reflection.

In This Section

Related Sections

C# Language Specification

For more information, see the following sections in the C# Language Specification:

  • Appendix A Documentation Comments

See Also

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Problem to genrate Xml Documentation in Asp.net Website in VS2008.

hi
I want to create xml documentation from /// comment in aspx.cs page. I am using Asp.net 3.5 Website instead of Webapplication. there fore we never see any option to genrate xml Document. please Help me.


Thanks & Regards
Rohit Kumar Gupta
grohitk@yahoo.co.in

  
[tfl - 01 07 09] Hi - and thanks for your post. You should post questions like this to the MSDN Forums at http://forums.microsoft.com/msdn or the MSDN Newsgroups at 

  

    http://www.microsoft.com/communities/newsgroups/en-us/. You are much more likely get a quicker response using the forums than through the Community Content. For specific help about:
Visual Studio  : http://groups.google.com/groups/dir?sel=usenet%3Dmicrosoft.public.vstudio%2C&
SQL Server     : http://groups.google.com/groups/dir?sel=usenet%3Dmicrosoft.public.sqlserver%2C&
.NET Framework : http://groups.google.com/groups/dir?sel=usenet%3Dmicrosoft.public.dotnet.framework
All Public     : http://groups.google.com/groups/dir?sel=usenet%3Dmicrosoft.public%2C&
History
Advertisement