[C#] exception cref="NotImplementedException"

메서드에 summary를 작성하던 중에 아래와 같이 summary가 생겼다.

나중에 한참 메서드를 다 구현하고 나서 발견해서 왜 <exception>태그가 생겼는지 알 수 없었다.

/// <summary>
/// 메서드 설명
/// </summary>
/// <param name="a"></param>
/// <returns></returns>
/// <exception cref="NotImplementedException"></exception>

 

NotImplementedException는 요청한 메서드 또는 연산이 구현되지 않을 때 throw되는 예외이다.

 

코드를 작성할때를 생각해보면 interface를 상속받아 구현을 했었다. 

초기에 인터페이스를 구현하면 아무것도 작성되지 않은 상태이고, 혹시라는 이때 summary를 작성해서 생겼나? 라는 생각이 들었다. 

 

처음 인터페이스를 구현하면 아래와 같이 메서드가 생성이 된다.

이 상태에서 summary를 생성하면 위의 summary와 동일하게 출력되었다.

public class test : ITest
{
    public int testFunction(int a)
    {
        throw new NotImplementedException();
    }
}

<exception> 태그를 사용하면 해당 메서드를 사용할 때 IntelliSense의 예외에 출력된다.

///를 입력하는 시점(summary 생성하는 시점)에서 해당 메서드가 포함하고 있는 모든 정보들을 자동으로 생성하는 것 같다.

 

 

📎XML 문서 주석 참고

https://learn.microsoft.com/ko-kr/dotnet/csharp/language-reference/xmldoc/recommended-tags

클래스 및 해당 멤버에 대한 권장 XML 문서 태그 - C#

https://learn.microsoft.com/ko-kr/dotnet/csharp/language-reference/xmldoc/examples

XML 문서 주석 예제 - C#