RCS1140.md

RCS1140: Add exception to documentation comment

Property	Value
Id	RCS1140
Category	Maintainability
Severity	Hidden

Example

Code with Diagnostic

/// <summary>
/// ...
/// </summary>
/// <param name="parameter"></param>
public void Foo(object parameter)
{
    if (parameter == null)
        throw new ArgumentNullException(nameof(parameter)); // RCS1140
}

Code with Fix

/// <summary>
/// ...
/// </summary>
/// <param name="parameter"></param>
/// <exception cref="ArgumentNullException"><paramref name="parameter"/> is <c>null</c>.</exception>
public void Foo(object parameter)
{
    if (parameter == null)
        throw new ArgumentNullException(nameof(parameter));
}

See Also

• How to Suppress a Diagnostic

(Generated with DotMarkdown)