Game Development Reference
In-Depth Information
Table 11.1 List of Standard Tags
Tag
Description
<c>
This tag is used to specify that a certain group of words should be formatted as
text.
<code>
This tag is used to specify multiple lines of code in a block of text. In order to
embed XML source, you must specify the tag attribute escaped=”true” on the
code tag so that the documentation compiler does not strip out the XML sample.
<example>
This tag is used to specify how to use a particular method or type. Typically, the
code tag is also used with this tag to give implementation details.
<exception>
This tag is used to specify the exceptions that a particular class can throw.
<include>
This tag is used to refer to comments in an external file, avoiding the need to
embed other comments in your source code.
<list>
This tag is used to define a heading row of either a table or a definition list. Each
item in the list is specified with an <item> tag, and a list or table can have as
many <item> tags as desired.
<item>
This tag is used to define an item in a table or a definition list.
<newpara>
This tag is used inside text to allow for formatted structuring.
<param>
This tag is used to specify a parameter for a method declaration.
<paramref>
This tag allows you to specify that a particular word is a parameter so that it can
be formatted distinctly.
<permission>
This tag allows you to specify the security access to a member.
<remarks>
This tag allows you to specify overview information about a class or type. You can
also use the summary tag to describe a member for a type.
<returns>
This tag is used to describe the return value for a method declaration.
<see>
This tag allows you to specify a link to appear within text. You can also use the
<seealso> tag to place text that you want to appear in the See Also section.
<seealso>
This tag allows you to place text that you want to appear in the See Also section.
You can use the <see> tag to specify a link to appear within text.
<summary>
This tag should be used to describe a member for a type. You can also use the
<remarks> tag to list information about the type itself.
<value>
This tag is used to describe a property and is suggested for use on all properties.
You will notice that the auto commenting macro for properties only inserts the
summary tag, so you will have to add this tag manually to all your properties.
Some documentation tags are further defined through the use of XML attributes.
The tag attributes used by inline documentation are presented in Table 11.2.
Search Nedrilad ::




Custom Search