C# 주석과 문서화 XML 주석 활용

코드를 작성할 때 주석은 협업과 유지보수에 큰 도움을 줍니다. C#에서는 일반 주석과 XML 문서화 주석을 지원합니다.

1. 일반 주석 종류

C#의 일반 주석은 두 가지입니다.

// 한 줄 주석
/* 
  여러 줄 주석 
*/

간단한 설명이나 코드 의도를 적을 때 활용합니다.

2. XML 문서화 주석

XML 주석은 코드에 대한 문서 생성을 자동화할 때 씁니다. 메서드, 클래스, 프로퍼티 위에 사용하는데, 삼중 슬래시(///)로 시작합니다.

/// <summary>
/// 두 수를 더하는 메서드입니다.
/// </summary>
/// <param name="a">첫 번째 정수</param>
/// <param name="b">두 번째 정수</param>
/// <returns>합계</returns>
public int Add(int a, int b)
{
    return a + b;
}

이 주석을 활용하면 Visual Studio에서 인텔리센스 툴팁에 설명이 나타나고, XML 기반 문서 생성기가 문서화 자료를 추출합니다.

3. 문서화 주석 활용 팁

• <summary>: 메서드나 클래스의 간단한 설명
• <param>: 매개변수 설명
• <returns>: 반환 값 설명
• <remarks>: 추가 설명

이렇게 체계적으로 작성하면 협업 시 큰 도움이 됩니다.