Information Technology Reference
In-Depth Information
Using Other XML Tags
In the preceding examples, you saw several XML tags that were supplied by Visual Studio.
These included
summary
,
param
, and
returns
. There are also a number of other tags that C#
recognizes. Some of the most important are listed in Table 23-3.
Table 23-3.
Documentation Code XML Tags
Tag
Meaning
<code>
Format the enclosing lines, in a font that looks like code.
<example>
Mark the enclosing lines as an example.
<param>
Mark a parameter for a method or constructor, and allow a description.
<remarks>
Describe a type declaration.
<returns>
Describe a return value.
<seealso>
Create a
See Also
entry in the output document.
<summary>
Describe a type or a type member.
<value>
Describe a property.
