Programming/C Lang Lecture

[C언어 강좌]11강 : 주석으로 코드 설명하기

yutaejeong 2014. 7. 28. 18:03


Written By Imperfect

[C언어 강좌]11강 : 주석으로 코드 설명하기



목차

1. 주석 이란?

2. 주석 사용해보기



1. 주석 이란?

주석이란, 본문에 뜻을 알기쉽게 풀어 쓴것을 말합니다.

프로그래밍 환경에서는 소스코드에 도움이 되는 정보를 삽입하기위해 쓰입니다.

(위키 백과 참고)

만약 소스코드 예제를 받았는데, 그 안에 자신이 모르는 것이 있다던가, 복잡해서 알아보기 힘들다던가 할떄, 주석이 있으면 이해하기 쉬워집니다.

또한, 주석을 이용하여 문단을 나눌때 유용하게 쓰입니다.


2.주석 사용해보기

주석을 사용하려면 주석을 입력할 부분 바로 앞에다가 "//"을 입력하면됩니다.

이 경우는 주석을 한 줄만 쓸수있습니다.

만약 여러 줄을 쓰고 싶다면 주석이 시작된는부분에 "/*"을 입력하고,

끝나눈부분엔 "*/"를 입력하면 됩니다. 한번 예제를 봐봅시다.

1
2
3
4
5
6
7
8
9
10
11
12
/*
----프로그램 정보 ----
만든이 : Imperfect
만든날짜 : 2014.07.28
설명 : 주석설명을 위한 프로그램 
*/
#include<stdio.h>
int main()
{
    printf("Hello, world!");//출력을 합니다.;
    return 0;
} 
위의 소스를 컴파일해서 실행해보면 아무런 오류가 뜨지 않습니다.
컴파일러가 주석은 컴파일하지 않기 때문입니다.

또한 아래와 같이 사용하면 어떻게 될까요?


1
2
3
4
5
6
7
8
9
10
11
12
13
/*
----프로그램 정보 ----
만든이 : Imperfect
만든날짜 : 2014.07.28
설명 : 주석설명을 위한 프로그램 
*/
#include<stdio.h>
int main()
{
    printf/*printf함수는 문자열을 출력합니다.*/
    (/*문자열 앞뒤로는 큰따옵표를 붙여야 합니다.*/"Hello, world!");//출력을 합니다.;
    return 0;
} 

위의 소스에서 printf함수 뒤에 주석을 넣고, "Hello, world!"앞에 주석을 넣었습니다.
한번 결과를 봐봅시다.

정상적으로 출력이 되었습니다.

하지만 주석을 이렇게 사용하는것은 올바르지 않습니다.

소스를 볼때 알아보기 힘들기 때문입니다.

오늘강좌는 여기까지 하겠습니다.


[C언어 강좌]11강 : 주석으로 코드 설명하기