TypeName | DOC200UseXmlDocumentationSyntax |
CheckId | DOC200 |
Category | Portability Rules |
The documentation for the element contains an HTML element equivalent to a known XML documentation element.
A violation of this rule occurs when an XML documentation comment contains an HTML element instead of the corresponding XML documentation comment syntax.
To fix a violation of this rule, use the expected XML documentation element instead of the HTML element.
HTML Element | XML Element |
---|---|
<p> |
<para> |
<tt> |
<c> |
<pre> |
<code> |
<ol> |
<list type="number"> |
<ul> |
<list type="bullet"> |
#pragma warning disable DOC200 // Use XML documentation syntax
/// <summary>
/// Summary text with <tt>inline code</tt>.
/// </summary>
public void SomeOperation()
#pragma warning restore DOC200 // Use XML documentation syntax
{
}