Supported XML Documentation Tags
This page lists the XML documentation elements that Kampose renders. Use Best Practices for authoring guidance rather than treating every supported element as required.
Standard XML Documentation Tags
The following standard XML documentation tags are fully supported:
| Tag | Top-Level | Description | Example |
|---|---|---|---|
<c> | No | Used for inline code snippets within documentation. It renders short code fragments inline with text. | Use <c>int</c> for integer values |
<code> | No | Represents a block of code formatted in a pre-formatted style, typically for multi-line code samples. | <code>var x = new Example();</code> |
<example> | Yes | Provides an example demonstrating how a type or member is used in practice. | <example>This shows basic usage...</example> |
<exception> | Yes | Documents an exception that a method or property may throw. | <exception cref="ArgumentNullException">...</exception> |
<include> | Yes | Allows external XML documentation to be included within the current documentation file. | <include file="docs.xml" path="doc/member[@name='T:MyType']/*" /> |
<inheritdoc> | Yes | Inherits documentation from a base class or implemented interface. | <inheritdoc cref="BaseClass.Method" /> |
<list> | Yes | Defines a list within documentation, such as bullet points, numbered lists, or table to structure information. | <list type="bullet">...</list> |
<para> | No | Inserts a paragraph break within documentation. | <para>This is a new paragraph.</para> |
<param> | Yes | Describes a parameter of a constructor, method, or index property. | <param name="value">The input value</param> |
<paramref> | No | Refers to a specific method parameter within documentation. | When <paramref name="count"/> is negative... |
<permission> | Yes | Declares required security permission for accessing a type or member. | <permission cref="SecurityPermission">...</permission> |
<remarks> | Yes | Provides additional information or context about an element that may not fit within the summary. | <remarks>This is used internally...</remarks> |
<returns> | Yes | Describes the return value of a method or delegate. | <returns>The calculated value</returns> |
<see> | No | Creates hyperlinks to related types, members, language-specific keywords, or external pages within the documentation. | See <see cref="OtherClass"/> for details |
<seealso> | Yes | Adds a 'See Also' reference linking to related documentation or external resources. | <seealso cref="RelatedMethod"/> |
<summary> | Yes | Provides a brief description summarizing the purpose of a type or member. | <summary>Represents a configuration...</summary> |
<typeparam> | Yes | Describes a generic type parameter used in methods or types. | <typeparam name="T">The type of items</typeparam> |
<typeparamref> | No | References a generic type parameter within documentation. | The <typeparamref name="T"/> parameter must be... |
<value> | Yes | Specifies a detailed description of a property value. | <value>The current connection state</value> |
Extended XML Documentation Tags
Additionally, the following extended tags from Sandcastle are supported:
| Tag | Top-Level | Description | Example |
|---|---|---|---|
<event> | Yes | Describes an event that a method or property may raise. | <event cref="MyEvent">Raised when...</event> |
<note> | No | Creates a note-like section within a topic to draw attention to some important information. | <note type="warning" title="Important">Be careful to...</note> |
<overloads> | Yes | Provides common documentation for a set of overloaded members. | <overloads>Common description for all overloads</overloads> |
<threadsafety> | Yes | Specifies thread safety of a class or structure, detailing whether static and instance members are safe for concurrent use. | <threadsafety static="true" instance="false"/> |