Ensure code coverage exclusions are justified

Docs > コード分析 > Static Analysis Rules > Ensure code coverage exclusions are justified

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

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()
    {
    }
}