C++ 주석: 가독성 높고 유지보수하기 좋은 코드 작성법

C++ 주석 완전 정복

C++ 주석이 왜 중요한지, 두 가지 주요 스타일, 그리고 더 명확하고 유지보수하기 좋은 코드를 위해 주석을 어떻게 활용하는지 마스터하세요.

C++에서 주석은 개발자가 코드를 읽고 이해하는 데 도움을 주는 주석입니다. 컴파일러는 주석을 완전히 무시하므로, 개발자는 맥락을 추가하거나 로직을 설명하거나 코드를 일시적으로 비활성화할 수 있습니다.

주석을 추가하는 두 가지 표준 방식:

• // – 한 줄 주석
• /* */ – 여러 줄 주석

---

한 줄 주석

//로 시작하는 모든 줄은 주석으로 처리됩니다. 예:

// 변수 선언
int a;
// 변수 'a'에 값 2 초기화
a = 2;

위 스니펫에서 첫 두 줄은 각 단계를 설명하는 한 줄 주석입니다. 코드 줄 끝에 주석을 달 수도 있습니다:

int a; // 변수 선언

---

여러 줄 주석

/*와 */ 사이의 모든 내용은 한 줄 또는 여러 줄에 걸친 주석입니다. 예:

/* 
 * 변수 선언
 * 직원 급여 저장을 위해
 */
int salary = 2000;

이 문법은 간단한 구간부터 긴 구간까지 유연하게 문서화할 수 있습니다.

---

디버깅을 위한 주석 활용

주석으로 코드를 일시적으로 비활성화하면 버그 격리에 유용합니다. 다음 프로그램을 보세요:

#include <iostream>
using namespace std;
int main() {
    cout << "some code";
    cout << ''error code;
    cout << "some other code";
    return 0;
}

컴파일 실패 시, 문제 줄을 삭제 대신 주석 처리:

#include <iostream>
using namespace std;
int main() {
    cout << "some code";
    // cout << ''error code;
    cout << "some other code";
    return 0;
}

프로 팁: 대부분의 IDE에서 주석 토글 단축키를 제공합니다. Windows: Ctrl + /, macOS: Cmd + /.

---

왜 주석을 써야 할까요?

주석은 코드를 시간이 지나도 자신과 팀원이 이해하기 쉽게 유지하는 살아있는 문서입니다. 코드가 무엇을 하는지 단순히 반복하기보다, 결정의 이유(Why)를 설명해야 합니다.

참고: 엉성한 코드를 주석으로 설명하려 하지 마세요. 명확하고 자명한 로직을 짜고, 필요한 맥락만 주석으로 보충하세요.

일반적 원칙: 구현의 메커니즘이 아닌, 솔루션의 이유를 설명하는 데 주석을 사용하세요.