Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.07 KB

DOC200.md

File metadata and controls

50 lines (40 loc) · 1.07 KB

DOC200

TypeName DOC200UseXmlDocumentationSyntax
CheckId DOC200
Category Portability Rules

Cause

The documentation for the element contains an HTML element equivalent to a known XML documentation element.

Rule description

A violation of this rule occurs when an XML documentation comment contains an HTML element instead of the corresponding XML documentation comment syntax.

How to fix violations

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">

How to suppress violations

#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
{
}