VisualStudio C#에서 함수에 설명을 추가하는 방법

먼저 함수에 설명을 추가하는 이유는

이전 버전에서 사용을 해야하는 경우가 있을 수 도 있고, 경고를 하기에도 좋다.

다른 프로그래머나 또는 내가 기능을 어디에서나 쉽게 알 수 있도록 하기에도 좋은것으로 보인다.

마우스만 올리면 주석이 따라와서 보이기 때문이다.

 

VisualStudio C#에서 함수에 설명을 추가하는 방법은 2가지가 있습니다.

 

1. Obsolete 사용

[Obsolete("\n이 함수는 아무런 기능이 없는 테스트 함수입니다.")]
        static void TestFunc001()
        {
            Console.WriteLine("함수 콜");
        }

이런식으로 obsolete를 추가해주면

main에서 해당함수를 선언 후, 마우스를 위에 가져다 대면 "이 함수는 아무런 기능이 없는 테스트 함수입니다"라고 읽을 수 있다.

 

 

2. ///

/// <summary>
/// 이 함수는 매개변수를 하나 받아서 출력하는 함수입니다.
/// </summary>
/// <param name="descStr">이 변수는 문자열로 이루어진 설명을 받아서 저장하는 변수</param>
/// <returns>함수가 정상 동작했을 때 true를 리턴합니다</returns>
static bool DescFunc001(string descStr)
{
	Console.WriteLine("함수 콜, 매개변수 -> {0}",descStr);
	return true;
}

함수를 작성 후 위쪽 라인에 ///를 입력해주게 되면

summary와 함께 param name, return등에도 주석을 달아 줄 수 있다.

obsolete와 같이 마우스를 올리면 주석 내용들이 보이며, 타인에게 어떤 함수인지 또는 내가 확인할때 어떤 내용인지 알 수 있다.