Share via

CA1200: 접두사로 cref 태그를 사용하지 마십시오.

  • 아티클
속성 값
규칙 ID CA1200
타이틀 접두사를 사용하여 cref 태그 사용 방지
범주 설명서
수정 사항이 주요 변경인지 여부 주요 변경 아님
.NET 8에서 기본적으로 사용 아니요

원인

XML 문서 주석의 cref 태그는 접두사를 사용합니다.

규칙 설명

XML 문서 태그의 cref 특성은 “코드 참조”를 의미합니다. 태그의 내부 텍스트를 형식, 메서드, 속성 등의 코드 요소로 지정합니다. cref 태그는 컴파일러가 참조를 확인하는 것을 방지하므로 접두사와 함께 사용하지 마세요. 또한 접두사를 함께 사용하면 Visual Studio IDE(통합 개발 환경)에서 리팩터링 중에 기호 참조를 찾아 업데이트할 수 없습니다. 접두사 없이 전체 구문을 사용하여 cref 태그에서 기호 이름을 참조하는 것이 좋습니다.

위반 문제를 해결하는 방법

해당 규칙 위반 문제를 해결하려면 cref 태그에서 접두사를 제거합니다. 예를 들어 다음 두 코드 조각은 규칙의 위반과 위반을 해결하는 방법을 보여 줍니다.

// Violates CA1200
/// <summary>
/// Type <see cref="T:C" /> contains method <see cref="F:C.F" />
/// </summary>
class C
{
    public void F() { }
}

// Does not violate CA1200
/// <summary>
/// Type <see cref="C" /> contains method <see cref="F" />
/// </summary>
class C
{
    public void F() { }
}

경고를 표시하지 않는 경우

컴파일러에서 참조 형식을 찾을 수 없으므로 코드 참조에서 접두사를 사용해야 할 때는 해당 경고를 표시하지 않아도 됩니다. 예를 들어 코드 참조가 전체 프레임워크에서 특수한 특성을 참조하지만 파일이 이식 가능한 프레임워크에 대해 컴파일되는 경우 해당 경고를 표시하지 않아도 됩니다.

경고 표시 안 함

단일 위반만 표시하지 않으려면 원본 파일에 전처리기 지시문을 추가하여 규칙을 사용하지 않도록 설정한 후 다시 사용하도록 설정합니다.

#pragma warning disable CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200

파일, 폴더 또는 프로젝트에 대한 규칙을 사용하지 않도록 설정하려면 구성 파일에서 심각도를 none으로 설정합니다.

[*.{cs,vb}]
dotnet_diagnostic.CA1200.severity = none

자세한 내용은 방법: 코드 분석 경고 표시 안 함을 참조하세요.

참고 항목