C언어 주석 종류 - 한줄 // 여러줄 /* ~ */

C언어에서 주석을 작성하는 방법은 2가지가 있다.

`//`을 사용하여 한 줄로 코드를 설명하고, `/* ~ */`을 사용하여 여러 줄로 코드를 설명할 수 있다.
주석을 작성하는 이유는 코드의 목적, 동작, 목적 등 다양하며, 유지보수를 위한 필수적인 설명을 작성하기 위함이다.

개발을 하는 사람들에게 코드를 잘 작성하는 것도 중요하지만, 주석을 잘 작성하는 것 또한 중요하다.

`예술적인 코드 작성보다 주석 한 문장 잘 작성한 것이 더 낫다`라는 얘기가 가끔 나오는 이유이기도 하다.

C언어 주석 종류 - 한줄 // 여러줄 /* ~ */

1.뜻과 의미

C언어에서 `주석`은 프로그램 실행과는 무관하게 코드의 의도와 동작을 설명하기 위해 작성하는 설명문이다.

컴파일러는 주석을 무시하며 실행 결과에는 영향을 주지 않는다.

다만, 개발자와 다른 협업자에 코드의 구조와 목적을 전달하는 역할을 한다.

주석은 영어로는 Comment, 한자로는 註釋 ( 註 글 뜻 주, 釋 풀다 석 ) 으로 `글로 풀어 의미를 전달하다` 정도로 볼 수 있다.

• 주석
• 영어: Comment / 논평, 언급
• 한자: 註釋 ( 註 글 뜻 주, 釋 풀다 석 ) / 글로 풀다

2.주석 꼭 필요할까

주석의 의미는 코드를 설명하는 간단한 설명을 작성하는 부분이다.

변수의 용도, 함수의 목적, 파라미터와 결과 등을 간단히 작성하고, 추후 유지보수와 코드의 수정시 참고하도록 하고 있다.

난이도가 있는 프로젝트의 경우, 주석을 규격화하여 필시 작성하도록 하는 곳들도 있다.

다른 사람이 작업을 이어 받았을 경우 시간을 줄이고, 코드의 목적을 명확하게 위함이다.

자세하게 작성할 필요는 없지만, 만약, 주석이 필요한 경우 작성할 꼭 작성할 몇 가지가 있다.

/**
 * name:
 * object:
 * parameter:
 * return:
 */

위의 내용은 거의 비슷하게 들어가며 IDE 같은 개발툴의 함수 또는 메서드에 마우스를 올리면 간단히 볼 수 있는 것들이다.

위의 주석 내용에 대한 내용은 아래를 참고한다.

• name
  - 파일명, 클래스, 함수, 메서드 등의 이름을 작성한다.
• object
  - 사용 목적을 작성한다.
• parameter
  - 입력되는 값들이 있다면 작성한다.
• return
  - 실행 후 결과값이 있다면 작성한다.

3.주석을 작성하는 2가지 방법

C언어에서 주석을 작성하는 방법은 크게 2가지가 있다.

`한 줄 주석( // )`과 `여러 줄 주석( /* */ ) ` 주석이다.

단어 그대로,

한 줄 주석은 코드의 단 한 줄만 사용하며 // 기호를 하용하여 주석을 작성한다.

여러 줄 주석은 코드에서 여러 줄에 주석을 작성할 수 있으며 /* */ 기호를 사용한다.

간단한 사용법은 다음과 같다.

3.1.한 줄 주석 // Comment

한 줄 주석은 말 그대로 한 줄로 간단한 내용을 작성하는 것을 의미한다.

파일, 클래스, 함수 또는 메서드, 변수명까지 모든 영역에서 작성한다.

복잡하지 않고, 간단한 설명문을 추가한다고 생각하면 된다.

주석의 형태는 `// 내용( Comment )` 이다.

// 주석 ( Comment ) 내용

3.2.여러 줄 주석 /* Comment */

여러 줄 주석은 파일, 클래스, 함수 또는 메서드, 변수명 등의 설명을 여러 줄로 작성하는 것을 의미한다.

/* Comment */ 형태로 작성하며, 좀 더 상세한 내용을 작성할 수 있도록 해준다.

상세한 설명이 필요한 경우 작성하며, 본인의 경우 한 줄 주석 대신에 여러 줄 주석을 주로 사용하는 편이다.

여러 줄 주석을 사용하는 형태는 다음과 같다.

/* 
   여러
   줄
   주석
*/

4.주석 양식

보통의 주석 양식은 다음과 같을 것이다.

개발자들이 보통 주석을 잘 작성하지 않는 이유는 귀찮음이라는 아주 간단한 이유인데, 프로그램 유지보수 일을 하게 되면 이런 주석의 사용은 정말 귀중하고 소중하다.

주석으로 설명이 없다면 처음부터 끝까지 파고 들어야 하는 시간이 허비되는 일이 대다수.

어쨌든 아래의 주석 형태로 기록으로 남기면 잊어버린 것들의 기억이 살아난다.

`기록은 기억을 지배한다`라고 했던가.

아래는 일반적인 주석의 형태이다.

/**
 * @brief 설명
 * @param 파라미터 
 * @param 파라미터 
 * @return 결과값 설명
 */

아주 간단하다. 굳이 설명이 필요 없다.

다만, 주석을 어떻게 사용할지는 프로젝트마다 다를 것이다.

본인의 프로젝트라면 귀찮은 유지보수와 기능 업데이트를 위한 주석은 작성하도록 하자.