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:
/// <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.
The XML doc comments are not metadata; they are not included in the compiled assembly and therefore they are not accessible through reflection.
Recommended Tags for Documentation Comments
Processing the XML File
Delimiters for Documentation Tags
How to: Use the XML Documentation Features
For more information, see:
/doc (Process Documentation Comments)
XML Documentation Sample
For more information, see the following sections in the C# Language Specification:
Appendix A Documentation Comments
hiI 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 & RegardsRohit Kumar Guptagrohitk@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.frameworkAll Public : http://groups.google.com/groups/dir?sel=usenet%3Dmicrosoft.public%2C&
[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.frameworkAll Public : http://groups.google.com/groups/dir?sel=usenet%3Dmicrosoft.public%2C&