Recommended Tags for Documentation Comments

This page is specific to

Microsoft Visual Studio 2003/.NET Framework 1.1

Other versions are also available for the following:

C# Programmer's Reference

The C# compiler will process documentation comments in your code to an XML file. Processing the XML file to create documentation is a detail that needs to be implemented at your site.

Tags are processed on code constructs such as types and type members.

Note Tags are not processed on namespaces.

The compiler will process any tag that is valid XML. The following tags provide commonly used functionality in user documentation:

<c>	<para>	<see>¹
<code>	<param>¹	<seealso>¹
<example>	<paramref>¹	<summary>
<exception>¹	<permission>¹	<value>
<include>¹	<remarks>
<list>	<returns>

1. Compiler verifies syntax.

See Also