C# 프로그래밍 - 주석(Comment)을 작성하는 방법(한줄주석, 여러줄주석, xml주석)

C# 프로그래밍 - 주석(Comment)을 작성하는 방법(한줄주석, 여러줄주석, xml주석)

C#에서 주석(Comment)은 코드에 대한 설명이나 메모를 작성할 수 있는 기능입니다. 주석은 컴파일러에 의해 무시되며 프로그램 실행에는 영향을 주지 않습니다. 

 

한 줄 주석(Single-line Comment)

한 줄 주석(단일 행 주석)은 // 기호를 사용하여 표시하며 해당 줄에서 // 이후의 모든 내용은 주석으로 처리됩니다.

 

예시

// 이것은 단일 행 주석입니다.

int x = 5;  // 변수 x에 5를 할당합니다.

 

여러 줄 주석(Multi-line Comment)

여러 줄 주석(다중 행 주석)은 여러 줄에 걸쳐 주석을 작성할 때 사용하는 방법입니다. 
/*로 시작하여 */로 종료하는 블록으로 사이에 있는 모든 내용이 주석 처리됩니다. 

 

예시

/*
이것은
다중 행 주석입니다.
여러 줄에 걸쳐
주석을 작성할 수 있습니다.
*/
int y = 10;  // 변수 y에 10을 할당합니다.

 

XML 주석(XML Documentation Comments)

XML 주석은 코드의 문서화와 IntelliSense(자동 완성 및 도움말) 기능을 지원하기 위해 사용됩니다.

/// 기호로 시작하는 행 주석으로 작성되며 일반적으로 클래스, 메서드, 속성 등의 멤버 선언 바로 위에 작성됩니다.<summary>, <param>, <returns>와 같은 XML 태그를 사용하여 각각 요소(클래스, 메서드, 속성 등)의 설명, 매개변수 설명, 반환 값 설명 등을 제공합니다.

 

예시

/// <summary>
/// 이 주석은 Calculate 메서드의 요약 설명을 제공합니다.
/// </summary>
/// <param name="parameter">매개변수에 대한 설명</param>
/// <returns>반환 값에 대한 설명</returns>
public int Calculate(int parameter)
{
    // 코드 내용
}