DOC104.md

DOC104

TypeName	DOC104UseSeeLangword
CheckId	DOC104
Category	Style Rules

Cause

The documentation contains a language keyword reference using <c>keyword</c> that can be converted to the preferred form <see langword="keyword"/>.

Rule description

A violation of this rule occurs when documentation contains a language keyword reference written in inline code that can be written in a preferred form using see langword.

/// <summary>
/// This type is <c>sealed</c>.
/// </summary>
public sealed class SomeType
{
}

How to fix violations

To fix a violation of this rule, replace the inline code with the equivalent see langword syntax.

/// <summary>
/// This type is <see langword="sealed"/>.
/// </summary>
public sealed class SomeType
{
}

How to suppress violations

#pragma warning disable DOC104 // Use 'see langword'
/// <summary>
/// This type is <c>sealed</c>.
/// </summary>
public sealed class SomeType
#pragma warning restore DOC104 // Use 'see langword'
{
}