Ensure code coverage exclusions are justified

문서 > 코드 분석 > 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()
    {
    }
}