Ensure code coverage exclusions are justified

Docs > Code Analysis > Static Analysis Rules > Ensure code coverage exclusions are justified

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: csharp-best-practices/coverage-justification

Language: C#

Severity: Warning

Category: Best Practices

Description

When using ExcludeFromCodeCoverage, always provide a reason for the exclusion. This helps with code maintenance and is part of the documentation that helps other engineers understand why the code is excluded from coverage.

Non-Compliant Code Examples

class MyClass {
    [ExcludeFromCodeCoverage]
    public void MyMethod()
    {
    }
}

Compliant Code Examples

class MyClass {
    [ExcludeFromCodeCoverage(Justification = "Code used by some flaky test that will be removed soon")]
    public void MyMethod()
    {
    }
}