자바스크립트 주석의 정의와 사용 방법

이번에 진행할 주제는 '주석의 정의와 사용 방법'입니다. 위의 이미지의 타이틀처럼 내용은 길지 않고 어렵지도 않습니다. 이번 포스팅에서는 주석이란 무엇인지 알아보도록 할 것이며, 어떻게 사용할 수 있는지에 대해서 알아보도록 하겠습니다. 작성한 글들을 다시 읽어보면서 조금씩 포스팅을 깔끔하고 가독성이 좋도록 작성하도록 노력해보겠습니다.

---

주석의 정의

---

주석이란 과연 무엇일까요? 한마디로 표현하면 '주석 = 설명'으로 한 문장으로 표현할 수 있습니다. 주석은 주로 작성한 코드에 대해서 설명을 달아놓기 위하여 사용합니다. 주석은 실행이 되지 않으며, 선택이 아닌 필수라고 생각합니다.

---

한 줄 주석

---

한 줄 주석의 사용방법에 대해서 알아보도록 하겠습니다. 보통 한 줄 코드에 대한 설명으로 사용됩니다. 간단한 주석을 사용할 때 사용되며, '//'을 입력한 다음 남기고 싶은 말을 작성합니다.

index.html

주석의 사용은 다음과 같습니다. '//주석내용'으로 한 줄 주석 처리가 가능합니다. 작성한 코드를 실행하더라도 //뒤의 "주석 처리입니다."는 실행 결과에 영향을 미치지 않습니다.

작성한 코드를 실행하더라도 다음과 같이 출력 되지 않습니다. 앞에서 알아보았던 "document.write" 문장을 사용하지 않았기도 하지만, 주석은 실행 결과에 영향을 미치지 않기 때문입니다.

index.html

다음의 코드를 통하여 확인해보도록 하겠습니다. "document.write(test1);"문장을 통하여 test1를 출력해보도록 하겠습니다. 과연 "//주석처리"는 코드에 영향을 미칠까요?

실행결과입니다. test1에 저장된 "주석"만 출력되고 주석은 실행결과에 아무런 영향을 미치지 않는것을 알 수 있습니다.

---

여러 줄 주석

---

한 줄 주석이 있다면 여러줄을 주석처리 해야 하는 경우도 있습니다. 여러 줄 주석의 경우에는 한 줄 코드가 아닌 여러 줄로 설명하기 위하여 사용하거나, 작성한 일정 영역을 주석처리 하여 결과의 차이를 알아 볼 때에도 사용되곤 합니다.

index.html

사용방법은 다음과 같습니다. '/* 주석내용 */' 아까는 '// 주석내용 '이었지만, 지금은 /사이에 *이 붙어있습니다. 그리고 차이점은 매 줄 마다 '//'을 붙이지 않아도 된다는 점입니다. 마찬가지로 실행하면 결과에는 영향을 미치지 않습니다.

출력에는 아무 영향을 미치지 않는것을 확인할 수 있습니다.

보통 다음과 같이 여러줄을 설명하거나, 작업한 내용의 설명작성등 다양한 용도로 사용됩니다. 여러 사람들이 작성하는 코드거나 1년뒤에 봤을 때 빠르게 이해하기 위하여 주석을 사용하곤 하는데 주석의 사용은 선택이 아닌 필수라고 생각합니다.

그렇다면, 아래의 두 사진에서의 차이점은 무엇일까요?

index.html

다음의 코드에서는 test1을 정의하고 test1을 "바꿈"으로 변경하고 다시 한 번 "다시바꿈"으로 변경하였습니다. 결국 선언하고 바꾸고 다시 한 번 값을 바꾸어주었습니다. 다음의 경우에는 출력하면 어떤 결과가 나올까요?

index.html

위의 코드에서는 여러 줄 주석을 사용하였습니다. 바꿈과 다시바꿈을 주석처리 하였다면 출력에서는 어떤 결과를 나타낼까요? 

전과 후 입니다. 다음과 같이 주석처리 하지 않았을 경우에는 다시 바꾸는 문장이 적용되어 "다시바꿈"을 출력하였지만, 주석처리 하였을 경우에는 "주석"을 출력하는 것을 확인하실 수 있습니다.