Intro
대부분의 개발자들에게 코드에서 가장 많이 접하는 표현이 무엇이냐고 물어보면 필자의 100% 뇌피셜로 같은 답변이 나올 것이다.
주석(Comment)을 가장 많이 봅니다.
주석은 컴퓨터가 아닌 사람에게만 유용한 message로 컴파일러는 이 부분을 무시한다. 즉, 다른 이가 이 코드를 볼 때 쉽게 이해할 수 있도록 돕는 길잡이이자 코드로는 필요가 없으나 필수적인 정보들(ex. License)을 담기 위해 사용된다. 물론 여기까지 본다면 이와 같이 되물을 수 있다. 잘 짠 코드는 주석이 필요 없는데?
120% 동의한다. 최고의 코드는 Self-documentation이 되는 코드라고 생각한다. 그러나 모든 코드를 혼자 작성할 수 없기 때문에 개발자에게 협업은 필수이며, 주석 역시 개발 및 협업에 필수적인 요소이다. 아무리 코드를 잘 짜도 주석이 작성되지 않은 코드는 보기가 싫어지며, 가독성에 심각한 악영향을 미친다. 즉, 읽는 이를 배려해서 주석을 작성하는 습관을 들이면 매우 바람직하다고 생각한다.
C++에서 주석을 어떻게 작성할까? 대부분의 언어가 그렇듯 C++ 역시 두 가지 방법의 주석 작성법을 제공한다.
Comment
주석 표시가 된 Single Line만 주석 처리를 해주는 방식과, 시작과 끝을 지정할 수 있는 Multiline comment가 존재한다. 두 가지 방법은 각각 아래와 같다.
- Single-line Comment
// searchingFundamental.cpp
#include <iostream>
// 슬래시 두 개를 연달아 적으면 이 줄 끝까지 주석처리가 됩니다 :)
int main()
{
std::cout << "Searching Fundamental" << std::endl;
// std::cout << "You can't read me, compiler!" << std::endl;
return 0;
}
- Multiline Comment
// searchingFundamental.cpp
#include <iostream>
//'/*'으로 주석의 시작점을, '*/'으로 주석의 끝점을 지정할 수 있습니다 :D
int main()
{
std::cout << "Searching Fundamental" << std::endl;
/*
std::cout << "You can't read me, compiler!" << std::endl;
You can't find my syntax error, compiler!!!
*/
return 0;
}
Style
주석 스타일은 협업을 위해 굉장히 중요하다. 매우 다양한 종류가 있으며 자신들의 주석 스타일에 맞는 코드인지 점검해주는 라이브러리도 존재한다. 후에 코딩 스타일을 다룰 때 주석 스타일 역시 자세히 다루도록 하겠다. 그러나 지금 다루기에는 너무 양이 많고, 준비가 덜 된 상태이다. 또한, 현업을 경험하니 사실 회사에 있는 Comment Style을 따르는 것이 정답이라고 생각한다. 같이 일할 동료들이 원하는 스타일로 주석은 작성하자.
중요한 건 주석을 작성하는 습관을 갖는 것이라고 생각한다. 다양한 스타일을 적용해보고 자신만의 Rule을 만들어 일관성 있게 주석을 작성해보자. 그렇다면 현업에서도 회사의 주석 스타일에 적응하기 수월할 것이다.
Reference
- 전문가를 위한 C++
Next
간혹 더이상 사용하지 않거나, 디버깅을 위한 코드를 주석으로 치워버리는 경우가 보인다. 물론 필자도 많이 사용했고, 정말 편리하다. 하지만 이런 습관은 읽는 이의 가독성을 떨어뜨리는 좋지 않은 습관이라고 생각한다. 놀랍게도 전처리 지시자를 사용하면 가독성을 비교적 덜 저하시키며 코드 블록을 disable 시킬 수 있다. 다음 글에서는 이렇게 알면 편하거나 꼭 알아야 하는 전처리 지시자에 대해 다뤄보겠다.
