2.(3) C Fundamentals - 주석 작성

2.3 Comments

 우리의 pun.c 프로그램은 아직 부족하다. 바로 문서화이다. 모든 프로그램에는 프로그램 이름, 작성된 날짜, 작성자, 프로그램의 목적 등 식별 정보가 포함되어야 한다. C에서 이 정보는 주석에 배치하면 된다. 기호 /*는 주석의 시작부분을 표시하고 기호 */는 끝부분을 표시한다.

*/ This is a comment */

 주석은 프로그램의 거의 모든곳에서 별도의 행이나 다른 프로그램 텍스트와 같은 행에 나타낼 수 있다. pun.c의 시작부분에는 다음과 같이 주석을 쓸 수 있다.

/* Name: pun.c                 */
/* Purpose: Prints a bad pun.  */
/* Author: K. N. King          */

#include <stdio.h>

int main(void)
{
    printf("To C or not to C: that is the question.\n");
    return 0;
}

 주석은 둘 이상의 줄에 걸쳐 확장할 수 있다. 컴파일러가 /*기호를 확인한 후 */기호를 만날때 까지는 이어지는 내용을 읽고 무시한다. 위 주석을 다음과 같이 짧게 만들 수 있다.

/* Name: pun.c                
   Purpose: Prints a bad pun.  
   Author: K. N. King          */

 하지만, 가독성이 떨어지기 때문에 권하지는 않는다. 차라리 다음과 같이 하면 도움이 된다.

/* Name: pun.c                
   Purpose: Prints a bad pun.  
   Author: K. N. King     
*/

더 좋은 방식의 주석은, 다음처럼 박스로 만드는 것이다.

/*************************************
 * Name: pun.c                       *
 * Purpose: Prints a bad pun.        *
 * Author: K. N. King                * 
 *************************************/

가끔씩 박스형 주석을 단순화 시키는 프로그래머들도 있다.

/*
 * Name: pun.c 
 * Purpose: Prints a bad pun. 
 * Author: K. N. King 
 */

짧은 주석은 프로그램 코드와 같은 줄에도 표시될 수 있다.

int main(void)  /*Beginning of main program*/

이런 주석을 날개형 주석이라고도 부른다.

C99부터는 다음과 같은 주석을 제공한다.

//This is a comment

이런 주석 유형은 줄 끝에서 자동으로 끝난다. 두줄 이상의 주석을 만드려면 이전 버전 주석(/**/)을 사용하거나 각 주석의 줄 시작부분에 넣으면 된다.

// Name: pun.c
// Purpose: Prints a bad pun.
// Author: K. N. King

새로운 주석 스타일은 두가지 중요한 점이 있는데, 첫번째로 코멘트가 자동으로 줄의 끝에서 끝나기 때문에 종료되지 않은 주석이 프로그램의 일부를 실수로 가릴 가능성이 없다. 두번째로, 각 줄에 요구되는 // 덕분에 긴 줄의 주석이 돋보인다.