[C#] 'Obsolete' Attribute - 더 이상 사용하지 않는 것에 효율적으로 알리는 방법

프로그래밍을 할 때 설계되로 흘러가지 않는다. 왜냐하면 확장성, 재사용성, 더 나은 구조 같은 경우에 따라 설계는 변한다.

Base 코드를 작성한 사람의 함수가 추후 사용하지 않는다면 다른 개발자에게 해당 사항을 전달하고 또 이와 관련된 개발자에게 전달한다면 너무 불편해진다. 이러한 상황을 해결하기위해 'Obsolete' 라는 Attribute 가 있다.

'Obsolete' 를 사용하는 상황은 더 이상 사용하지 않거나 or 사용하지 않을 예정인 함수, 변수 앞 에 '[Obsolete]' Attribute 를 붙여주면 된다.

---

class Test
{
	[Obsolete]
	public void Method()
    	{
    
    	}
}

 

'Obsolete' 를 사용하면 해당 함수를 호출할 때 초록색 밑줄과 함께 더이상 사용하지 않는 함수라는 경고가 발생한다.

'Obsolete' Attribute 설정된 Method() 호출된 화면

 

---

 

'Obsolete' Attribute 는 3가지 방식의 오버로딩을 지원한다.

 

1. Obsolete()

속성	값
IsError	flase
Message	해결 방법 메시지입니다.
DiagnosticId	null
UrlFormat	null

 

2. Obsolete(String)

   해결 메시지를 사용하여 새 인스턴스를 초기화 한다.

- 매개 변수
   message String
   해결 방법 또는 설명하는 텍스트 문자열

속성	값
IsError	flase
Message	해결 방법 메시지입니다.
DiagnosticId	null
UrlFormat	null

 

3. Obsolete(String, Boolean)

   해결 메시지와 오래된 요소를 사용하는 것이 오류로 간주되는지 여부를 나타배는 Boolean 값을 사용하여

   인스턴스를 초기화한다.

- 매개 변수
   message String
   해결 방법 또는 설명하는 텍스트 문자열
   error Boolean
   사용되지 않는 요소 사용에서 컴파일러 오류가 발생하는 경우 true, 컴파일 오류가 발생하지 않는 경우 false

 

'Obsolete' Attribute 를 적절하게 사요하면 다른 개발자에게 코드가 변경되었음을 알리는 정보와 그에 대한 해결책도 전해 줄 수 있다.

해당 함수 작업자가 다른 작업자에게 변경사항을 일일이 알리는 것보다 훨씬 효과적으로 해결할 수 있다.

 

 

 

---

＃내맘대로 요약

'Obsolete' Attribute를 사용하여 다른 개발자에게 해당 함수, 변수에 대해 변경되었음을 훨씬 효과적으로 알릴수 있다.

함수, 변수를 사용하지 않을 시 해당 Attribute를 적극적으로 사용하자.