Share via

CA1720: 식별자에 형식 이름을 포함하면 안 됩니다.

  • 아티클
속성 값
규칙 ID CA1720
타이틀 식별자에 형식 이름을 포함하면 안 됩니다.
범주 이름 지정
수정 사항이 주요 변경인지 여부 주요 변경
.NET 8에서 기본적으로 사용 아니요

원인

멤버의 매개 변수 이름에 데이터 형식 이름이 포함되어 있습니다.

또는

멤버의 이름에 언어 관련 데이터 형식 이름이 포함되어 있습니다.

기본적으로 이 규칙은 외부에 표시되는 멤버만 확인하지만 이는 구성 가능합니다.

규칙 설명

매개 변수 및 멤버 이름은 개발 도구에서 제공해야 하는 형식을 설명하기 보다는 의미를 전달하는 데 더 적합합니다. 데이터 형식 이름을 사용해야 하는 경우 멤버 이름에는 언어 관련 이름 대신 언어 독립적인 이름을 사용합니다. 예를 들어 C# 형식 이름 int 대신 언어 독립적인 데이터 형식 이름 Int32를 사용합니다.

매개 변수 또는 멤버 이름의 각 불연속 토큰은 대/소문자를 구분하지 않는 방식으로 다음과 같은 언어 관련 데이터 형식 이름에 대해 확인됩니다.

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • 정수
  • UInt
  • 정수
  • UInteger
  • Long
  • ULong
  • 부호 없음
  • Signed
  • Float
  • Float32
  • Float64

또한 매개 변수의 이름도 대/소문자를 구분하지 않는 방식으로 다음과 같은 언어 독립적 데이터 형식 이름에 대해 확인됩니다.

  • Object
  • 부울
  • Char
  • 문자열
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • 포인터
  • UInptr
  • UPtr
  • UPointer
  • 단일
  • 두 배
  • 소수
  • GUID

위반 문제를 해결하는 방법

매개 변수에 대해 발생한 경우:

매개 변수 이름의 데이터 형식 식별자를 의미를 더 잘 설명하는 용어나 더욱 일반적인 용어(예: ‘값’)로 바꿉니다.

멤버에 대해 발생한 경우:

멤버 이름의 언어 관련 데이터 형식 식별자를 의미를 더 잘 설명하는 용어, 언어 독립적인 용어 또는 더욱 일반적인 용어(예: ‘값’)로 바꿉니다.

경고를 표시하지 않는 경우

경우에 따라 형식 기반 매개 변수 및 멤버 이름을 사용하는 것이 적절할 수 있습니다. 그러나 새로운 개발에서는 이 규칙의 경고를 표시하지 않아도 되는 알려진 시나리오가 없습니다. 이전에 제공된 라이브러리인 경우 이 규칙의 경고를 표시하지 않아야 할 수 있습니다.

경고 표시 안 함

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

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

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

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

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

분석할 코드 구성

다음 옵션을 사용하여 이 규칙이 실행될 코드베이스 부분을 구성합니다.

이 규칙, 적용되는 모든 규칙 또는 적용되는 이 범주의 모든 규칙(명명)에 대해 이 옵션을 구성할 수 있습니다. 자세한 내용은 코드 품질 규칙 구성 옵션을 참조하세요.

특정 API 화면 포함

접근성을 기반으로 이 규칙을 실행할 코드베이스의 파트를 구성할 수 있습니다. 예를 들어 규칙이 퍼블릭이 아닌 API 표면에서만 실행되도록 지정하려면 프로젝트의 .editorconfig 파일에 다음 키-값 쌍을 추가합니다.

dotnet_code_quality.CAXXXX.api_surface = private, internal