XML Documentation Equivalents for Javadoc Comments
XML documentation may be generated from Javadoc comments. This topic shows the XML documentation equivalents to Javadoc comments.
Remarks
The following table shows the XML documentation equivalents to Javadoc:
| Javadoc comment tag | XML documentation equivalent |
|---|---|
None |
<remarks> or <summary> |
@author name |
<author> name </author> |
@deprecated description |
<obsolete> description </obsolete> |
@exception exception-class text |
<exception cref="exception-class">text</exception> |
@param paramname text |
<param name=paramname> text </param> |
@return text |
<returns>text</returns> |
@see typename |
<seealso cref="typename"/> |
@see typename#member |
<seealso cref="typename.member"/> |
@value property-description |
<value> property-description </value> |
@version text |
<version> text </version> |
Note
The @value tag is Visual J#-specific.
Note
A comment that contains no tags is converted to a <remarks> tag if it is a type, or a <summary> tag if it is a method, field, or constructor.