주석(Comment)은 C++ 코드 안에 포함할 수 있는 설명문입니다. 주석은 소스 코드를 읽는 사람이 코드의 의도와 동작을 쉽게 이해하도록 돕는 중요한 역할을 합니다. 실제로 모든 프로그래밍 언어는 어떤 형태로든 주석 기능을 제공하며, 잘 작성된 주석은 유지보수성과 협업 효율을 크게 높여줍니다.
C++는 한 줄 주석(single-line comment)과 여러 줄 주석(multi-line comment), 두 가지 방식을 지원합니다. 주석 내부에 포함된 모든 문자는 컴파일 과정에서 완전히 무시되므로, 프로그램의 실행 결과에는 아무런 영향을 주지 않습니다.
1. 한 줄 주석(Single-line Comment)
한 줄 주석은 // 기호를 사용해 작성합니다. 주석을 시작하고 싶은 위치 앞에 //만 붙이면 되며, 그 줄의 나머지 부분 전체가 주석으로 처리됩니다.
// 이것은 한 줄 주석입니다 cout<<"Hello"; // 문장 뒤에 붙인 주석입니다.
위 예시처럼 한 줄 주석은 코드 위에 별도로 작성할 수도 있고, 실행문 뒤에 이어서 간단한 설명을 덧붙일 수도 있습니다. 변수나 함수의 역할을 짧게 메모할 때 특히 유용합니다.
2. 여러 줄 주석(Multiline Comment)
여러 줄에 걸쳐 작성되는 주석은 흔히 블록 주석(block comment)이라고도 불립니다. /*로 시작해서 */로 끝내며, 그 사이에 있는 모든 내용이 주석으로 처리됩니다.
/* 이것은 여러 줄에 걸친 주석입니다 */
블록 주석은 함수나 클래스에 대한 상세한 설명, 알고리즘의 동작 원리, 파일 단위의 개요 등 긴 내용을 담을 때 적합합니다.
주석 활용 팁
- 코드가 무엇을 하는지보다 왜 그렇게 작성했는지를 설명하는 주석이 더 가치 있습니다.
- 임시로 코드를 비활성화할 때도 주석을 활용할 수 있지만, 불필요한 주석 처리된 코드는 정기적으로 정리하는 것이 좋습니다.
- 주석은 코드 변경 시 함께 업데이트해야 하며, 오래된 주석은 오히려 혼란을 줄 수 있습니다.