[C언어] 주석이란?

주석은 C언어뿐만 아니라 모든 언어에서 사용하게 된다. 코드의 의미를 명확히 하게 위해 존재하며, 단순히 코드가 무엇을 하는지를 넘어 왜 그렇게 작성되었는지를 설명하는 것이 중요하다.

 

주석의 사용법을 봐보자.

#include <stdio.h>

/**
 * @brief 전달받은 이름을 출력하는 함수
 * 
 * @param Name 출력할 이름 (문자열 포인터)
 */
void printMyName(char *Name) {
    printf("%s\n", Name);  // 이름 출력
}

int main(void) {
    char myName[] = "홍길동";
    
    /* char myName[] = "김강민";
    char myName[] = "이윤찬"; */
    
    printMyName(myName);
    return 0;
}

 

// 을 사용하면 한 줄 주석을 할 수 있고, /*  */ 사이에 주석 처리할 내용을 삽입하여 여러 줄 주석도 가능하다.

맨 위에 주석 방식은 함수의 목적을 간단하게 설명하고, @param을 사용해 매개변수를 정의한다. 또한 @note를 사용하여 함수 사용 시 주의할 점이나 유의 사항을 설명할 수 있고, @return을 사용하여 반환 값을 설명할 수 있다.