C#] Deprecated Method 표시, 미사용 함수 표시

C#에서 어떻게 deprecated method를 표시하는지 알아보자. 

 

Preparing the Environment

public static class DateUtils
{
    public static int GetCurrentYearV1()
    {
        return 2022;
    }

    public static int GetCurrentYearV2()
    {
        return DateTime.UtcNow.Year;
    }
}

현재 연도를 가져오는 함수가 2개 있다. GetCurrentYearV1() 함수는 과거 연도를 반환한다. GetCurrentYearV2() 함수가 현재 연도를 가져오기 더 적합하다. 

 

ObsoleteAttribute

GetCurrentYearV1() 함수에 ObsoleteAttribute를 사용하므로 deprecated method임을 표시한다. 

[Obsolete]
public static int GetCurrentYearV1()
{
    return 2022;
}

ObsoleteAttribute With Message

[Obsolete("GetCurrentYearV2()함수를 대신 사용하세요.")]
public static int GetCurrentYearV1()
{
    return 2022;
}

ObsoleteAttribute With Error

경고만이 아니라, 에러를 발생시킬 수 있다. ObsoleteAttribute는 optional Error property를 제공한다. 

[Obsolete("Please use GetCurrentYearV2() instead.", true)]
public static int GetCurrentYearV1()
{
    return 2022;
}

 

결론

다른 개발자들이 특정 함수를 더 이상 사용하지 않도록 할 수 있다. 코드 관리와 대안함수를 적용하도록 격려한다. 

deprecation 메시지도 제공하고, 개발자들이 권장된 접근방법을 사용하도록 안내할 수 있다.