C# 세미나 자료: 주석 (Comments)

1. 개요

C# 프로그래밍에서 **주석(Comment)**은 코드의 이해를 돕고, 문서화를 통해 협업과 유지보수를 용이하게 만드는 중요한 도구입니다. 본 세미나에서는 C#의 주석 사용법을 초급, 중급, 고급 수준으로 나누어 이론과 함께 다양한 예제를 중심으로 설명합니다.

---

2. 기본 이론

2.1 주석이란?

• 정의: 코드에 대한 설명이나 메모를 남기기 위한 텍스트로, 컴파일러는 무시함
• 역할:
  • 코드 이해도 향상
  • 문서화 (특히 자동 문서 생성 도구와 연계 시)
  • 임시 코드 비활성화

2.2 주석의 종류

• 한 줄 주석: // 로 시작
• 여러 줄 주석: /* */ 로 감싸기
• 문서 주석 (XML 주석): /// 로 시작하며 메서드, 클래스 등에 설명 부여 가능

---

3. 단계별 설명

3.1 초급

이론 요약

• // 로 간단한 설명 작성
• /* */ 로 여러 줄 주석 가능

예시 코드

// 이 변수는 사용자 나이를 저장합니다
int age = 30;

/*
 이 메서드는 사용자 이름을 출력합니다
 여러 줄 주석으로 설명 가능
*/
void PrintName()
{
    Console.WriteLine("홍길동");
}

주의사항

• 주석 처리된 코드는 실행되지 않음
• 중첩된 /* */ 사용은 허용되지 않음 (C# 문법 오류 발생)

---

3.2 중급

이론 심화

• 문서 주석(XML 주석) 사용
• Visual Studio에서 /// 입력 시 자동 생성 지원
• <summary>, <param>, <returns> 태그 등 활용

예시 코드

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

팁

• 문서 주석은 IntelliSense(자동완성 도움말)에 표시되어 코드 이해도 향상
• XML 주석은 docfx, Sandcastle 같은 도구와 함께 자동 문서화 가능

---

3.3 고급

고급 활용 및 사례

• 조건부 주석 (주석 대신 전처리 지시문 활용)
• 코드 리뷰 시 TODO, FIXME, HACK 주석 활용
• 대규모 프로젝트에서 주석 스타일 가이드 도입

예시 코드

// TODO: 로그인 기능 추가 예정
// FIXME: 오류 발생 시 예외 메시지 출력 개선 필요

#if DEBUG
    Console.WriteLine("디버그 모드입니다.");
#endif

실무 팁

• 주석은 최신 상태 유지가 중요 (오래된 주석은 오히려 해로움)
• 의미 없는 주석은 피하고, "왜"를 설명하는 주석을 작성할 것
• 공용 API, 라이브러리 코드에는 반드시 XML 주석 작성 권장

---

4. 결론

• 주석은 코드 문서화 및 유지보수의 필수 도구
• 초급에서는 기본적인 //, /* */ 주석에 익숙해지고
• 중급에서는 XML 문서 주석을 활용
• 고급에서는 품질 있는 주석 전략과 문서화 도구까지 활용 가능

---

5. Q&A

• Q: //와 /* */ 중 어떤 걸 더 많이 사용하나요? A: 간단한 설명에는 //, 여러 줄 설명이나 코드 비활성화에는 /* */가 적합합니다.
• Q: XML 주석을 반드시 작성해야 하나요? A: 필수는 아니지만, API 문서화나 협업 시 매우 권장되는 방식입니다.

---

감사합니다!