16. 사람이 읽을 주석(;) 달기
목표
오토리습에서 프로그램에는 포함되지 않지만, 정보를 적어놓기 위해 사용하는 주석을 추가 해 봅시다.
주석(comment)이란
오토리습 코드들을 보면 저희가 일상적으로 사용하는 한글도 아닐뿐더러, 한번에 읽기가 어렵습니다. 이는 코드를 컴퓨터가 읽을 수 있도록 오토리습 문법에 맞춰서 코드를 적었기 때문입니다. 사람이 읽기 편한 글은 아니라는 거죠.
그러다보니 어떤 코드가 어떤 기능을 하는지 알기 위해서는, 하나씩 따라가보면서 흐름을 짐작 할 수 밖에 없습니다. 당장 코드를 작성할 때는 무슨 기능을 하는지 알지만, 시간이 흐른 후 다시 코드를 보거나 다른 사람이 코드를 볼 때에는 다시 코드를 파악할 필요가 있을겁니다.
이 때 해당 코드가 무슨 기능을 하는지, 또 개인적으로 남기고 싶은 말들을 적어 놓으면 좋을겁니다. 여기서 주석을 사용합니다.
컴퓨터는 모든 코드들을 읽지만 처리하지만, 주석처리가 되어 있는 부분은 읽지 않고 무시합니다.
주석 사용 해보기
오토리습에서는 ;를 사용하여, 현재 줄에서 ; 이후에 적힌 내용은 컴퓨터가 무시하도록 주석처리를 할 수 있습니다.(참고로 프로그래밍 언어마다 주석을 표시하는 방식은 다릅니다) 복붙 해 봅시다.
1
2
3
4
5
6
; 정상적으로 실행 될 경우 명령어창에 [정상실행]을 표시하는 함수
(progn
(setq str "정상실행") ;오토리습에서는 이렇게 ; 다음에 오는 글은
(princ str) ;컴퓨터가 읽지 않습니다.
(princ)
)
위 코드를 실행 해 보면, 각 줄에서 ; 다음에 오는 글은 컴퓨터가 읽지 않기 때문에 정상적으로 명령어 창에 정상실행이 표시되는 것을 확인 할 수 있습니다.
이렇게 주석을 달아놓으면, 나중에 코드를 읽을 때 무슨기능을 하는지 한번에 알 수 있습니다.
여러줄 주석 사용 해보기
;를 사용하면 한 줄에서만 주석을 달 수 있지만, ;|와 |;를 사용하면 여러 줄 주석을 달 수도 있습니다. 복붙 해 봅시다.
1
2
3
4
5
6
7
8
9
10
;|
이 사이에 위치한
모든 글들은
컴퓨터가 읽지 않습니다.
|;
(progn
(setq str "정상실행")
(princ str)
(princ)
)
이렇게 여러줄에 걸쳐서 주석을 달아야 하는 경우, ;|와 |; 사이에 글들을 적으면, 그 글들은 컴퓨터가 읽지 않게됩니다.