Skip to content

DOC100.md

Latest commit

 

History

History
65 lines (54 loc) · 1.16 KB

DOC100.md

File metadata and controls

65 lines (54 loc) · 1.16 KB

DOC100

TypeName DOC100PlaceTextInParagraphs
CheckId DOC100
Category Style Rules

Cause

A <remarks> or <note> documentation element contains content which is not wrapped in a block-level element.

Rule description

A violation of this rule occurs when a <remarks> or <note> documentation element contains content which is not wrapped in a block-level element.

/// <summary>Summary text.</summary>
/// <remarks>
/// Remarks text.
/// </remarks>
public void SomeOperation()
{
}

How to fix violations

To fix a violation of this rule, place the content in a block-level element, such as a <para> element.

/// <summary>Summary text.</summary>
/// <remarks>
/// <para>Remarks text.</para>
/// </remarks>
public void SomeOperation()
{
}

How to suppress violations

#pragma warning disable DOC100 // Place text in paragraphs
/// <summary>
/// Summary text.
/// </summary>
/// <remarks>
/// Inline remarks.
/// </remarks>
public void SomeOperation()
#pragma warning restore DOC100 // Place text in paragraphs
{
}