[C#] 문서 주석 XML 태그 간단 사용법

---

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

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

---

문서 주석 XML 태그

문서 주석 XML 태그는 XML 요소를 사용하여 문서의 여러 구조를 정의합니다.
변수, 클래스, 열거형, 열거형 맴버의 정의, 사용법이나 함수의 정의, 사용법, 매개변수, 반환 값에 대한 설명을 추가할 수 있습니다.

/// <summary>
/// 숫자를 나타냅니다.
/// </summary>
int number;

XML 태그는 ///로 시작하고 추가하려는 변수나 함수, 클래스 위쪽에 작성합니다.

해당 변수에 마우스를 갖다 대면 다음과 같이 작성한 설명 및 사용법을 확인할 수 있습니다.

---

<summary>

<summary>는 변수, 함수, 클래스, 구조체, 열거형, 열거형의 맴버의 설명이나 사용법을 추가할 수 있습니다.

/// <summary>
/// description
/// </summary>
// 형식 또는 형식 멤버

---

/// <summary>
/// 2022년도 1학기 점수입니다.
/// </summary>
int score;

마우스를 해당 변수에 갖다 대면 다음과 같이 설명을 확인할 수 있습니다.

---

<returns>

<returns>는 함수의 반환 값에 대한 설명을 추가할 수 있습니다.

/// <returns>
/// description
/// </returns>
// 반환값을 갖는 메서드

---

int score;

/// <returns>
/// 점수에 대한 등급을 반환합니다.
/// </returns>
char GetGrade() {
    if(score >= 90) {
        return 'A';
    } else if (score >= 80) {
        return 'B';
    } else if (score >= 70) {
        return 'C';
    } else if (score >= 60) {
        return 'D';
    } else {
        return 'F';
    }
}

마우스를 해당 메서드에 갖다 대면 다음과 같이 반환 값에 대한 설명을 확인할 수 있습니다.

---

<param>

<param>은 함수의 매개 변수에 대한 설명을 추가할 수 있습니다.

(매개 변수의 수 만큼 여러 개 추가할 수 있습니다.)

/// <param name="name">
/// description
/// </param>
// 매개 변수를 갖는 메서드

---

int score;

/// <param name="score">변경할 점수입니다.</param>
void SetScore(int score) {
    this.score = score;
}

마우스를 해당 매개 변수에 갖다 대면 다음과 같이 매개 변수에 대한 설명을 확인할 수 있습니다.

---

<paramref>

<paramref>은 <summary>의 코드 주석에 포함된 단어가 매개 변수를 참조함을 나타낼 수 있습니다.

/// <paramref name="name"/>

---

/// <summary>
/// <paramref name="score"/>를 변경합니다.
/// </summary>
void SetScore(int score) {
    this.score = score;
}

마우스를 해당 메서드에 갖다 대면 다음과 같이 매개 변수를 참조하는 설명을 확인할 수 있습니다.

---