Coding/C
C언어 주석의 이유와 주석 달기 방법
쏘얌무
2018. 4. 27. 16:58
이번에는 주석에 관해서 설명 드릴려고 합니다.
주석이란 코드를 작성하여 프로그램을 만들 때 컴파일되지 않는 부분으로 보통 코드를 이해하기 위해서, 설명하기 위해서 작성됩니다.
왜?
왜 사용 해야하나?
코드를 작성하다보면 이 함수의 기능이나 함수를 사용한 이유 등등 단시간에 쭉 작성하여 만드는 것이 아닌 긴시간에 걸쳐 작성하고 혼자만의 작업이 아니라 협력하여 작업하게 되는 경우가 많습니다.
코드를 분석하고 이해해야 하는데 이럴 경우에 주석이 없다면 많은 시간을 투자하거나 분석을 잘못할 수 있는 경우도 발생할 수 있습니다. 따라서 주석은 필수적으로 작성하도록 습관화 하는 것이 좋습니다.
그렇다면 주석을 다는 방법에 대해서도 말씀드리겠습니다.
방법은 두가지가 존재합니다.
예제를 들어가며 설명하겠습니다.
예제
#include <stdio.h> /* 헤더 선언 하기*/ int main(void) // Hello world!출력 { printf("hello world!\n"); return 0; /* printf로 hello world! 출력하고 return 0 으로 함수 종료 시킵니다. */ }
블럭 단위 주석
우선 두번째 줄에 '/* */' 를 보시면 사이에 주석할 내용을 작성하시면 됩니다.
'/* */' 주석은 블럭 주석이라고 하여 '/*'로 시작하여 '*/'로 끝내는 곳 까지 모두 주석처리를 합니다.
마지막에도
/*
printf로 hello world! ~
~ 종료 시킵니다.
*/
로 중간에 작성된 내용은 주석이 됩니다.
행 단위 주석
행단위 주석인 '//'는 '//'의 뒤로 그 줄(행) 에서 따라오는 것은 주석처리가 되는 것으로 다음 줄에는 영향을 미치지 않습니다.
주석 달기는 이것으로 마치겠습니다.
주석 달기와 함께 항상 변수를 초기화 하는 것도 습관화 하시는 것이 추천합니다.