다음을 통해 공유

CA1721: 속성 이름은 Get 메서드와 달라야 합니다.

  • 아티클
속성 값
규칙 ID CA1721
제목 속성 이름은 Get 메서드와 달라야 합니다.
범주 이름 지정
수정 사항이 주요 변경인지 여부 주요 변경
.NET 9에서 기본적으로 사용 아니요

원인

멤버 이름이 ‘Get’으로 시작하고 그러지 않으면 속성 이름과 일치합니다. 예를 들어 형식에 이름이 ‘GetColor’인 메서드와 이름이 ‘Color’인 속성이 포함되어 있으면 규칙 위반이 발생합니다. 이 규칙은 속성이나 메서드가 ObsoleteAttribute로 표시되는 경우 발생하지 않습니다.

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

규칙 설명

"Get" 메서드와 속성은 서로가 분명히 구분되는 이름을 사용해야 합니다.

명명 규칙은 공용 언어 런타임을 대상으로 하는 라이브러리에 대한 일반적인 모양을 제공합니다. 이러한 일관성으로 인해 새 소프트웨어 라이브러리를 학습하는 데 필요한 시간이 단축되고 라이브러리가 관리 코드 개발 관련 전문 지식을 갖춘 누군가에 의해 개발되었다는 사실에 고객 신뢰도가 향상됩니다.

위반 문제를 해결하는 방법

‘Get’으로 시작하는 메서드의 이름과 일치하지 않도록 이름을 변경합니다.

경고를 표시하지 않는 경우

이 규칙에서는 경고를 표시해야 합니다. 이 규칙의 한 가지 예외는 인터페이스를 구현하여 IExtenderProvider "Get" 메서드가 발생하는 경우입니다.

경고 표시 안 함

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

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

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

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

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

분석할 코드 구성

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

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

특정 API 화면 포함

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

메모

XXXX CAXXXX 부분을 해당 규칙의 ID로 바꿉니다.

예시

다음 예제에는 이 규칙을 위반하는 메서드 및 속성이 포함되어 있습니다.

public class Test
{
    public DateTime Date
    {
        get { return DateTime.Today; }
    }

    // Violates rule: PropertyNamesShouldNotMatchGetMethods.
    public string GetDate()
    {
        return this.Date.ToString();
    }
}

Imports System

Namespace ca1721

    Public Class Test

        Public ReadOnly Property [Date]() As DateTime
            Get
                Return DateTime.Today
            End Get
        End Property

        ' Violates rule: PropertyNamesShouldNotMatchGetMethods.
        Public Function GetDate() As String
            Return Me.Date.ToString()
        End Function

    End Class

End Namespace