3. 주석

3. 주석

주석이란 프로그래밍하면서 컴파일러가 아닌 사용자가 볼 수 있도록 참고하는 메모의 기능이다. 당연하지만 컴파일러는 없는 것으로 간주하며 주석을 삽입함으로 프로그램의 가독성이 증가하게 된다. 예를 들어, 내가 어떤 함수를 썼을 때, 이 함수의 의도를 밝히거나 하는 것이다. 프로그래밍은 짧으면 좋겠지만 분명 길어질 것이다. 길어지는데 내가 쓴 모든 것의 의도를 전부 기억하면 좋겠지만 긴 문장속에서 자기자신도 자신이 썼던 문장의 의도를 잊어버릴 수 있게 되는데 그러한 것도 주석을 통하여 프로그래밍의 속도를 가속시킬 수 있다. 물론 아주 쉽거나 기본적인 부분에는 쓰지 않는 것이 더 좋다. 그 적정도는 본인 스스로가 프로그래밍하면서 익히는게 중요하다. 아무튼 프로그래머에게 주석은 선택이 아닌 필수사항이다.

(1) 주석의 형태

- 단일행(한줄에만 해당) 주석 : //를 사용하여 주석을 오른쪽 끝에 달 수 있다.

"...함수나 내용... // 주석부분"

- 여러 줄에 걸칠 수 있는(복수행) 주석 : /*로 시작해서 */로 끝을 맺어서 사이에 주석을 달 수 있다.

"....함수나 내용...

/* 

주석부분 

*/ 

함수나 내용..."

(2) 주의사항

단일행 주석과 복수행 주석은 중복이 가능한데, 복수행 주석끼리 중복은 불가능하다. 예를 들어, 아래를 보자.

함수..

/* A /*B*/ C

*/ 

함수..

→ 이런식의 주석은 불가능하다. 이유는 /*가 입력되면 컴파일러는 그 이후에의 모든 내용을 씹는다. */가 나올 때 까지 말이다. 즉, /* 다음에 다시 /*가 나온다고 해서 삽입된 주석이 생기는 것이 아니라 /*를 주석으로 인식한다는 것이고 아래와 같이 컴퓨터가 인식한다는 것이다.

함수~~ 

/* A /*B 

*/ 

C

*/ 

 ⇒ /*없이, */가 바로 나온 것으로 인식하여 컴파일 오류 발생하게 됨

정리

- 주석 : 메모의 기능으로 컴파일러는 없는 것으로 간주한다. 가독성을 높여주므로 선택이 아닌 필수이다.

- 단일 행 주석 : " 내용 // 주석 "

- 복수 행 주석 : " 내용 /* 주석 */ 내용

↓ 

내용

/* 

주석

*/

- 복수행 주석의 중복이 불가능 하다.

- 단일행 주석과 섞는 것은 가능하다.

/* 주석이 시작된다. // 단일 행 주석

*/