C++ 초급 - 2. 기본 문법 (4 - 주석 (Comments))

2.4 주석 (Comments)

C++에서는 코드에 설명을 추가하거나 특정 코드의 실행을 막을 때 주석을 사용한다.
주석은 프로그램의 실행에 영향을 주지 않으며, 코드의 가독성을 향상시키고, 다른 개발자가 코드를 이해하기 쉽게 도와준다.

---

(1) 한 줄 주석 (//)

한 줄 주석은 // 기호 뒤에 작성되며, 그 줄의 끝까지 주석으로 처리된다.

📌 기본 사용법

#include <iostream>

int main() {
    // 이 줄은 주석 처리됨 (컴파일러가 무시함)
    std::cout << "Hello, C++!" << std::endl; // 이 부분도 주석
    return 0;
}

🔹 출력 결과

Hello, C++!

💡 한 줄 주석은 주로 다음과 같은 경우에 사용된다.

1. 코드 설명 추가

   int age = 25; // 사용자의 나이 저장
   

2. 디버깅을 위해 특정 코드 비활성화

   // std::cout << "디버깅 메시지" << std::endl; // 필요 없으면 주석 처리

3. 임시로 코드 변경

   int x = 10;
   // x = 20; // 이 줄을 잠시 비활성화
   std::cout << x << std::endl;

---

(2) 여러 줄 주석 (/* */)

여러 줄 주석은 /*로 시작하고 */로 끝나며, 여러 줄을 한 번에 주석 처리할 수 있다.

📌 기본 사용법

#include <iostream>

int main() {
    /*
      여러 줄의 주석을 사용할 때
      이 방법을 사용한다.
    */
    std::cout << "주석 예제" << std::endl;
    return 0;
}

🔹 출력 결과

주석 예제

💡 여러 줄 주석은 다음과 같은 경우에 사용된다.

1. 긴 설명 추가

   /*
      이 함수는 두 개의 정수를 입력받아
      더한 값을 반환한다.
   */
   int add(int a, int b) {
       return a + b;
   }
   

2. 코드 블록을 한 번에 비활성화

   /*
   std::cout << "이 부분은 실행되지 않음" << std::endl;
   std::cout << "다음 줄도 실행되지 않음" << std::endl;
   */

3. 라이선스 정보 또는 문서화

   /*
      프로그램명: Example Program
      작성자: 홍길동
      날짜: 2024-02-12
      설명: C++에서 주석을 사용하는 방법을 설명하는 예제 코드
   */

---

📌 // vs /* */ 비교

주석 유형	사용 방식	장점	단점
// 한 줄 주석	// 주석 내용	짧고 간결함	여러 줄 주석 시 불편
/* */ 여러 줄 주석	/* 여러 줄 */	긴 설명 가능	중첩 사용 불가능

💡 주의:

• 여러 줄 주석(/* */)은 중첩해서 사용할 수 없다.

  /* 
     첫 번째 주석
     /* 중첩된 주석 (오류 발생) */
  */
  

  • 해결 방법: 한 줄 주석(//)을 사용하거나, 주석을 나누어 사용.

---

📌 한 줄 주석과 여러 줄 주석을 조합하여 사용

#include <iostream>

int main() {
    // 사용자에게 메시지를 출력
    std::cout << "Hello, User!" << std::endl;

    /*
      여기에 나중에 새로운 기능을 추가할 예정
      std::cout << "추가 기능 메시지" << std::endl;
    */

    return 0;
}

💡 한 줄 주석과 여러 줄 주석을 조합하면, 코드 유지보수가 더 쉬워진다.

---

정리

주석 종류	설명	사용 예제
// 한 줄 주석	한 줄만 주석 처리	// 변수 초기화
/* */ 여러 줄 주석	여러 줄을 주석 처리	/* 함수 설명 */
사용 목적	코드 설명, 디버깅, 비활성화	코드 유지보수