C언어 # - 주석 달기

주석의 필요성

다른 누군가가 본인의 코드를 보거나, 아니면 본인이더라도 본인의 코드에 대해 직관적으로 이해할 수 있어야 시간을 절약하고 보다 깊은 이해로 효율적인 개발이 가능하다. 여기서 주석의 필요성이 나오게 된다. 현업에서는 함수 내에 주석을 달고, 그리고 다른 누가보더라도 쉽게 이해할 수 있도록 어떻게 주석을 달지 고민한다. 그만큼 중요한 역할을 한다.

 

블록 단위 주석

주석의 시작과 끝을 명시해서 주석을 다는 방식이다. /*를 시작으로 */로 마무리한다. 아래와 같다.

선언한 int A, intB, int sum이 선언되지 않는다.

#include <iostream>
using namespace std;

int main()
{
	/*
	int A, B;
	int sum;
	*/
}

 

다만, 아래와 같이 /* */ 사이에 /* */를 한번 더 사용하면 문제가 된다. 음영처리가 되지 않은 것을 볼 수 있다. 이를 주의하자.

#include <iostream>
using namespace std;

int main()
{
	/*
	
	/* int A, B; */
	int sum;
	*/
}

 

행 단위 주석

행 단위 주석은 //을 통해서 구현할 수 있다. int A와 int B 선언만 되지 않았다. 행 단위로 주석 처리한다.

#include <iostream>
using namespace std;

int main()
{
	// int A, B;
	int sum;
}

 

결과적으로 현업하면서 블록 단위 주석을 많이 사용하는 것 같다. 행 단위 주석은 살펴 보지 못한듯. 물론 분야마다 다르고 팀마다 다를 수 있다.