시작하며

오늘 할 이야기는 주석과 Enum의 관련된 정리이다.
열거형인 Enum은 변수의 여러 형태를 하고 진행할까 했는데 양이 적은 주석과 같이 하는게 좋다고 판단해서 이 포스팅의 정리하겠다.

정의

주석

• 어떤 글의 뜻을 쉽게 풀이하거나 보충 설명을 덧붙임. 또는 그 설명 자체

열거

• 항목들을 하나씩 나열하는 것

프로그래밍적 열거형

• 여러 개의 관련된 상수 값을 하나의 이름 아래 열거하여 정의하는 자료형

---

✅ 주석

주석은 위의 정의와 같이 어떤 글의 뜻을 쉽게 풀이하거나 보충 설명을 덧붙이는 것이다. 이 것을 프로그래밍적으로 얘기한다면 코드의 뜻을 쉽게 풀이하거나 보충 설명을 적는 것이다.

그래서 보통은 자신이 작업하면서 코멘트를 남겨 헷갈림을 방지 목적, 보충 설명을 남겨 같이 작업하는 사람에게 길잡이가 되는 경우도 있다. 이러한 경우 등으로 주석을 사용하게 된다.

당연하겠지만, 컴파일 시 실행되지 않는 문장이라서 컴파일러는 주석을 무시한다. 주석은 컴파일러가 파싱 후 버리기 때문에 IL 코드에 포함되지 않으므로 실행 파일 용량, 성능, 실행 시간과 무관하다.

🧪 기본 코드

// 한줄 쓰기 기능입니다.
// 한줄 주석 : 실행 시키지 않을 코드나 설명을 코드 상에 넣어서 유용하게 사용할 수 있는 기능


/* 범위 주석으로 쓰기 기능 입니다.*/
/* 
범위 주석: 시작(/*)에서 끝(* /)까지 주석으로 취급 할수 있는 기능
1
22
333
*/

/// <summary>
/// 이건 XML 주석이며
/// 문서 파일로 추출할 수 있습니다
/// </summary>

주석의 종류

형태	설명
//	한 줄 주석
/* */	여러 줄 주석
///	XML 문서 주석 (→ 문서 생성용)

• //, /* */ 주석은 코드에서 완전히 사라짐
• /// 주석만 XML documentation file 생성 시 남음 (csc /doc:MyApp.xml Program.cs 등으로 별도 파일 생성 가능)

🧪 예제 코드

using System;
namespace Study
{
    class Program
    {
        static void Main(string[] args)
        {
            // 한줄 쓰기 기능입니다.
            Console.WriteLine("Hello, World!");

            // 한줄 주석 : 실행 시키지 않을 코드나 설명을 코드 상에 넣어서 유용하게 사용할 수 있는 기능

            /* 
            범위 주석: 시작(/*)에서 끝(* /)까지 주석으로 취급 할수 있는 기능
            1
            22
            333
            */
            
            /// <summary>
            /// 이건 XML 주석이며
            /// 문서 파일로 추출할 수 있습니다
            /// </summary>
        }
    }
}

• 위와 같은 코드에서 실행 시키지 않을 코드나 설명을 코드 상에 넣어서 유용하게 사용할 수 있는 기능

주석은 컴파일 후 어디에도 없는가?

일반적으로 주석은 포함되지 않는다.
IL 코드에도, 디버깅 정보, 런타임 정보에도 포함되지 않는다.

단, XML 주석은 명시적으로 파일 생성 시에만 포함된다고 함

C# 컴파일러 동작 흐름

1. 소스 코드 읽기
2. 주석 제거(전처리) 지금까지 설명한거
3. 토큰화 > 구문 분석 > 중간 코드 생성 > IL 코드 > 실행 파일

---

✅ 총총(최종의 총정리)

• 주석 처리 방식은 컴파일러가 완전히 제거를 한다.
• IL에는 일반 주석은 포함되지 않는다.
• 실행 파일 포함되지 않는다.(.exe, .dll 에도 남지 않는다)
• 예외 상황도 있다. /// XML 주석은 별도 파일로 추출 가능하다.

---

어떤 유튜버가 총총, 이라면서 최종 요약해줬는데. 나도 총총하고 최종 내용을 요약하겠다.