[C#] C# 주석 사용 방법 및 종류

안녕하세요

오늘은 Visual Studio 툴을 사용하여 C# 개발 시 주석 사용 방법 및 종류에 대하여

포스팅해보겠습니다.

 

1. 주석 사용 이유

• 일반적으로 코드만 가지고는 정확하게 코드가 의미하는 바가 무엇인지 이해하기 힘들 때가 있습니다. 주석(Comment)은 코드에 추가적인 설명을 달아서 코드를 보다 읽기 쉽게 만들어 줍니다.

2. 주석 기본 사항

• 코드에 장식을 하지 않는다(배너식의 주석 자용을 자제합니다.)
• 주석은 가능한 한 단순하게 합니다.
• 코드 작성 이전에 주석부터 작성합니다.
• '무엇이 되었다'가 아니라 '무엇이 이러한 이유로 이렇게 되었다' 식으로 작성합니다.
• 주석 위치는 클래스의 시작, 각 메서드 선언의 바로 위에 합니다.
• 메서드 내부에서도 단계별로 구분지어서 설명할 필요가 있을 때에도 주석을 달도록 합니다.
• 변수 하나의 의미를 쓰는 주석 등은 사용하지 않습니다. 변수 이름을 명확하게 주어서 주석을 달 필요를 없애도록 해야 합니다.

3. C# 주석 포맷

• C#에서는 주석을 달기 위한 다양한 포맷을 제공합니다. 그중 XML 주석을 필수적으로 사용하도록 권장하며, 나머지 주석은 개발자의 편의에 따라 달도록 합니다.

 

• 단일 라인 주석
  • //로 시작하며, 해당 라인의 끝까지 적용됩니다.
  • 설명하고자 하는 코드의 바로 윗줄이나, 코드와 같은 라인의 오른쪽에 작성 합니다.
  • 하나의 라인이나 한 라인의 일부를 주석처리 해서 컴파일되지 않도록 임시로 막을 때에도 사용 됩니다.

if (j >1){
//해당 작업을 수행
....
}
else
return false; //수행할 작업이 없으므로 종료
//obj.Dosomething();

 

• 블록 주석
  • /*로 시작하여 */까지 적용 됩니다.
  • 한 줄 또는 여러 줄을 주석 처리하거나, 코드의 블록이 컴파일되지 않게 임시로 막을 때도 사용됩니다.

if(condition){
/* 해당 조건을 처리하는
	루틴을 여기에 작성해야 한다.
*/
}

 

• XML 주석
  • ///(단일 라인) 또는 /** */(블록)을 사용하며, XML 태그를 사용하여 주석을 달 수 있습니다.
  • 사용자 정의 형(클래스, 위임, 인터페이스) 또는 멤버(메서드)의 바로 앞에 사용합니다. 이 항목들은 반드시 XML 주석을 작성하도록 합니다.
  • VS.NET에서는 코드 편집창에서 주석을 달려는 사용자 정의 형이나 메서드 바로 위에 ///를 입력하면, 대상에 적합한 XML 주석 태그가 자동적으로 삽입됩니다.

/** <summary>text</summary> */

/**
<summary>text</summary>
*/

/**
* <summary>text</summary>
*/

 

**참고 사항

Visual Studio 에서 다중 범위의 주석 처리할 경우 단축 키를 알고 있으면 손쉽게 주석 처리 할 수 있습니다.

- 주석 처리 : Ctrl + K + C

- 주석 해제 : Ctrl + K + U

 

이상 c# 주석 사용 방법 및 종류에 대하여 알아보았습니다.