19.7 XML 문서 주석을 사용하여 함수 설명 작성하기

비주얼 스튜디오로 프로그램을 만들 때 특정 함수 사용법과 같은 설명을 표시하려면 /// <summary> ~ /// </summary> 형태로 슬래시 기호 3개를 연속해서 주석 영역에 작성합니다. 이것을 XML 문서 주석이라고 합니다. XML 문서 주석을 사용하면 비주얼 스튜디오에서 해당 함수에 마우스를 올리거나 코드를 작성할 때 관련 설명을 볼 수 있습니다.

XML 문서 주석을 사용하는 내용을 다루어 보겠습니다. 다음 내용을 입력한 후 실행해 보세요. XML 문서 주석은 AddNumbers() 함수를 먼저 만든 후 함수 선언문 앞에서 /// 코드를 작성하면 자동으로 완성합니다. <summary> 코드가 만들어지면 그 안에 함수 설명과 매개변수, 반환값 설명을 넣어 줍니다.

XML 문서 주석 사용: FunctionAddNumbers.cs

using System;

class FunctionAddNumbers
{
    /// <summary>
    /// 두 수를 더하여 그 결괏값을 반환시켜 주는 함수
    /// </summary>
    ///<param name="a">첫 번째 매개변수</param>
    ///<param name="b">두 번째 매개변수</param>
    ///<returns>a + b 결과</returns>
    static int AddNumbers(int a, int b)
    {
        return a + b;
    }

    static void Main()
    {
        int a = 3;
        int b = 5;
        int c = AddNumbers(3, 5);
        Console.WriteLine($"{a} + {b} = {c}");
    }
}

3 + 5 = 8

XML 문서 주석에는 해당 함수 이름과 매개변수 설명, 반환값을 작성할 수 있습니다. XML 문서 주석은 프로그램을 만든 후 유지보수를 할 때 함수 내용을 금방 알 수 있어 편리합니다.