Ensure code coverage exclusions are justified

문서 > Datadog 보안 > Code Security > Static Code Analysis (SAST) > SAST 규칙 > 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()
    {
    }
}