Export (0) Print
Expand All

B.2 Recommended tags

Visual Studio .NET 2003

The documentation generator must accept and process any tag that is valid according to the rules of XML. The following tags provide commonly used functionality in user documentation. (Of course, other tags are possible.)

Tag Section Purpose
<c>
B.2.1 Set text in a code-like font
<code>
B.2.2 Set one or more lines of source code or program output
<example>
B.2.3 Indicate an example
<exception>
B.2.4 Identifies the exceptions a method can throw
<include>
B.2.5 Includes XML from an external file
<list>
B.2.6 Create a list or table
<para>
B.2.7 Permit structure to be added to text
<param>
B.2.8 Describe a parameter for a method or constructor
<paramref>
B.2.9 Identify that a word is a parameter name
<permission>
B.2.10 Document the security accessibility of a member
<remarks>
B.2.11 Describe a type
<returns>
B.2.12 Describe the return value of a method
<see>
B.2.13 Specify a link
<seealso>
B.2.14 Generate a See Also entry
<summary>
B.2.15 Describe a member of a type
<value>
B.2.16 Describe a property
Show:
© 2015 Microsoft