C++ 입문 문법

C++ 주석과 코드 정리

C++ 주석과 코드 정리 — 초급

주석과 코드 정리

1. 도입 (왜 배워야 하는가)

주석과 코드 정리는 프로그래밍에서 매우 중요한 부분입니다. 실무에서 팀원들과 협업할 때, 또는 프로젝트를 장기간 유지보수할 때 코드가 어떻게 작동하는지 이해하는 데 도움이 됩니다. 주석이 없는 코드는 마치 아무런 힌트 없이 복잡한 퍼즐을 푸는 것과 같습니다. 특히, 새로운 팀원이 기존 코드를 이해하기 어려운 경우, 주석이 없는 코드는 큰 혼란을 초래할 수 있습니다. 주석을 적절히 활용하지 않으면, 코드의 의도와 기능이 명확하지 않아 버그를 수정하는 데 더 많은 시간과 노력을 소모하게 됩니다.

2. 핵심 개념 설명

주석은 코드에 대한 설명이나 메모를 추가하는 기능입니다. 주석은 프로그램 실행에 영향을 주지 않고, 코드의 가독성을 높이고 다른 개발자와의 소통을 원활하게 합니다.

한 줄 주석: //를 사용하여 한 줄 주석을 작성합니다.
여러 줄 주석: / ... / 형식으로 여러 줄 주석을 작성할 수 있습니다.

실생활 비유로, 주석은 요리책의 레시피에 있는 설명과 같습니다. 요리하는 사람에게 재료의 사용법이나 조리 방법을 알려줘서 더 나은 요리를 할 수 있도록 돕는 역할을 하죠.

주석 종류	형식	설명
한 줄 주석	`// 주석 내용`	한 줄의 설명을 추가합니다.
여러 줄 주석	`/ 주석 내용 /`	여러 줄의 설명을 추가합니다.

3. 기본 코드 예제

아래는 C++에서 주석을 사용하는 기본적인 예제입니다.

#include <iostream> // iostream 라이브러리 포함

int main() {
    // 변수 a와 b를 선언하고 초기화
    int a = 5; // a에 5 할당
    int b = 10; // b에 10 할당

    // a와 b의 합을 출력
    std::cout << "a + b = " << (a + b) << std::endl; // 합계 출력
    return 0; // 프로그램 종료
}

실행 결과:

a + b = 15

#include <iostream>: C++ 표준 입출력 라이브러리를 포함합니다.
int main(): 프로그램의 시작점을 정의합니다.
int a = 5;: a라는 변수를 선언하고 5로 초기화합니다.
int b = 10;: b라는 변수를 선언하고 10으로 초기화합니다.
std::cout << "a + b = " << (a + b) << std::endl;: a와 b의 합을 출력합니다.
return 0;: 프로그램을 정상적으로 종료합니다.

4. 실전 활용 예제

쇼핑몰 장바구니 구현

   #include <iostream>
   #include <vector>

   int main() {
       // 장바구니에 담을 아이템을 저장하는 벡터
       std::vector<std::string> cart; 
       cart.push_back("사과"); // 장바구니에 사과 추가
       cart.push_back("바나나"); // 장바구니에 바나나 추가

       // 장바구니의 내용을 출력
       std::cout << "장바구니에 담긴 아이템:" << std::endl;
       for (const auto& item : cart) {
           std::cout << item << std::endl; // 각 아이템 출력
       }
       return 0;
   }

이 코드에서는 장바구니에 여러 아이템을 추가하고, 그 내용을 출력합니다. 장바구니를 구현할 때 주석을 통해 각 단계의 의도를 명확히 할 수 있습니다.

게임 점수판

   #include <iostream>
   #include <map>
   
   int main() {
       std::map<std::string, int> scores; // 플레이어 점수를 저장하는 맵
       scores["플레이어1"] = 100; // 플레이어1의 점수
       scores["플레이어2"] = 200; // 플레이어2의 점수

       // 점수를 출력
       std::cout << "점수판:" << std::endl;
       for (const auto& player : scores) {
           std::cout << player.first << ": " << player.second << std::endl; 
       }
       return 0;
   }

게임에서 점수를 관리할 때, 각 플레이어의 점수를 저장하고 출력하는 예제입니다. 주석을 통해 변수의 용도를 설명합니다.

5. 흔한 실수와 주의사항

주석 없이 복잡한 코드 작성

- 잘못된 코드:

     int x = 10; // 이 코드의 의미는?

- 올바른 코드:

     int x = 10; // x는 사용자 나이를 저장합니다.

주석이 코드와 맞지 않는 경우