[c#] Obsolete 활용하기

Attribute 중 Obsolete 라는 친구가 있다. 영단어 해석을 하면 "더 이상 쓸모 없는" 이라는 뜻인데, 해석의 뜻과 같이 더 이상 필요없는 class나 변수, 함수에 쓸 수 있다. 사용 방법은 간단하다. 더 이상 쓰지 않는 class, 변수,  함수 앞에 [Obsolete("string")]  형식으로 작성을 하면 된다. 

 

유니티에서는 Monobehaviour를 상속받는 클래스, 즉 컴포넌트로 쓰일 클래스 앞에 Obsolete를 쓰면, 다음과 같은 모습이 인스펙터에서 보인다. 

여기서 "Not Supported Anymore" 라는 메세지는 Obsolete Attribute의 파라미터로 넘긴 string 값이다. 코드를 살펴보면 다음과 같다. (빨간색 화살표)

그리고 함수 앞에 Obsolete를 추가하게 되면 해당 함수를 사용했을 때, 마우스를 Hover했을 때 [사용되지않음] 이라는 메세지를 볼수 있다 (파란색 화살표)

 

추가로, Obsolete 파라미터로 메세지 string 값 뒤에 bool 값을 하나 더 넘길 수 있는데, true 값을 넘기면 error 표시를 하게 해준다.(노란색 화살표). 

bool 값으로 true를 넘겼을 때 유니티 인스펙터에서 보면 빨간색 경고 표시를 볼수 있다. 

 

Obsolete Attribute를 적극 활용해서, Legacy 인 클래스들 또는 변수들을 마크해서 협업 때 잘 활용하면 좋을 듯 하다.