XML Documentation Tags

Introduction
This article lists XML documentation tags which have been tested to work with AX.

Downloads

 * [[media:TutorialXmlDocumentationTags.xpo.zip|TutorialXmlDocumentationTags.xpo]] is a class which uses the tags discussed in this article.
 * [[media:TutorialXmlDocumentationTags.chm.zip|TutorialXmlDocumentationTags.chm]] is the compiled documentation for the TutorialXmlDocumentationTags class.

c
The c tag indicates that text within a description should be marked as code.

... /// /// The c tag indicates that text within a description should be marked as code. ///

code
The code tag is used in the documentation to indicate a block of code and its typical use is within an example tag.

///

example
The example tag is used to demonstrate the functionality of the code.

...  /// ///      ///

exception
The exception tag is used to describe the conditions that cause exceptions to be thrown by a method.

...  ///  ///    Thrown when an unrecoverable application error occurs. A catch block should assume ///    that all database transactions in a transaction block have been halted and rolled back. /// ///  ///    Thrown when a database transaction has deadlocked. ///

img
''Places an inline image in a document.

 /// 

list
''The list tag describes a numbered or bulleted list, a definition list or a table. The block is used to define the heading row of a table. When defining a table, you only need to supply an entry for term in the heading. Each item in the list is specified with an block.''

 ...        ...         ...         ...

/// ///   Bulleted List ///   Numbered List ///   Table /// /// /// ///   Bulleted List ///  Numbered List ///  Table /// /// /// ///   ///      List ///     Description ///   ///    ///      Bulleted List ///     A bulleted list using discs as bullets ///

note
The note tag makes special information more visible within the topic.

...  /// ///    The note type doesn't seem to make any visible difference. ///

para
''The para tag works like &lt;br&gt; or &lt;p&gt; in html to structure the text into paragraphs. It can be used to break a line of continuous text, or to wrap a segment of text into a paragraph.''

or ...  ///    The para tag works like <![CDATA[ or ]]> in html to ///    structure the text into paragraphs. It can be used to break a line ///   of continuous text, or to wrap a segment of text into a paragraph.

param
''The param tag is used to describe the parameters of the method. Parameter tags are automatically inserted into the header template if parameters are in the syntax. The name of the parameter is automatically inserted into the parameter tag. The parameter description should be brief.''

...  ///  ///    Used to demonstrate the usage of param</c> ///

paramref
The paramref tag indicates that a word in the code comments, for example in a or section refers to a parameter.

<paramref name="..."/> /// Applying paramref to <paramref name="_value"> demonstrates the usage of paramref.

permission
The permission tag is used to describe the permission that is required to access methods using the CodeAccessSecurity.demand method.

<permission cref="...">...  /// <permission cref="SecurityPermission"> /// <see cref="SecurityPermissionFlag.Execution">Execution privilege. /// /// <permission cref="ReflectionPermission"> /// <see cref="ReflectionPermissionFlag.MemberAccess">Member access privilege for reflection. ///

remarks
Provides information beyond what is documented in other tags.

...  /// ///      ///     Usage <![CDATA[ ... ]]> ///    A best practice warning is issued when the summary tag has no content ///

returns
Describes the value that the method returns.

...  /// ///     Demonstrates the usage of returns</c> ///

see
Assigns a hyperlink to the specified text.

<see href|cref|langword="..."/> or <see href="...">...  /// See <see cref="T:System.Enum">enumeration /// See <see cref="M:TutorialXmlDocumentationTags.code">code /// See <see href="http://www.microsoft.com">Microsoft ///

seealso
Adds a link to the "See Also" section.

<seealso href|cref="..."/> or <seealso href="...">...  /// <seealso cref="T:TutorialXmlDocumentationTags"/> /// <seealso href="http://microsoft.com"/> /// <seealso href="http://www.codeplex.com/Sandcastle">Sandcastle on CodePlex

summary
Provides a brief description of usage.

...  /// ///     Used to demonstrate the usage of summary</c> ///

Related Links

 * Microsoft Dynamics AX XML Documentation Tags
 * XML Documentation Comments Guide
 * Recommended Tags for Documentation Comments (C#)
 * Tags Supported by NDoc
 * C# and XML Source Code Documentation