JavaScript는 C 스타일과 C++ 스타일의 주석을 모두 지원합니다. 주석은 코드에 대한 설명을 남기거나, 특정 코드를 일시적으로 실행하지 않도록 만들 때 유용하게 활용됩니다. 아래에서 JavaScript에서 사용할 수 있는 주석의 종류를 하나씩 살펴보겠습니다.
JavaScript 주석의 종류
- 한 줄 주석(//) :
//부터 해당 줄의 끝까지 작성된 모든 텍스트는 주석으로 처리되며, JavaScript 엔진이 이를 무시합니다. - 여러 줄 주석(/* */) :
/*와*/사이에 작성된 모든 텍스트는 주석으로 처리됩니다. 여러 줄에 걸쳐 길게 작성할 수 있어 함수나 로직 전체에 대한 설명을 달 때 적합합니다. - HTML 주석 시작 기호(<!--) : JavaScript는 HTML 주석의 시작 기호인
<!--도 인식하며,//주석과 마찬가지로 한 줄 주석으로 취급합니다. - HTML 주석 종료 기호(-->) : 반면 HTML 주석의 종료 기호인
-->는 JavaScript에서 별도로 인식되지 않으므로, 반드시//-->처럼 앞에 슬래시 두 개를 붙여 작성해야 오류 없이 동작합니다.
주석 사용 예제
다음 예제는 실제 코드에서 여러 종류의 주석을 함께 사용하는 방법을 보여줍니다.
<script> <!-- // 이것은 한 줄 주석입니다. C++의 주석 작성 방식과 유사합니다. /* * 이것은 JavaScript의 여러 줄 주석입니다. * C 언어의 주석 작성 방식과 매우 흡사합니다. */ //--> </script>
참고: HTML 주석 기호를 사용하는 이유
<!--와 //-->로 코드를 감싸는 방식은 과거 JavaScript를 지원하지 않던 구형 브라우저에서 스크립트 코드를 화면에 그대로 출력하지 않도록 숨기기 위해 사용되던 관습입니다. 현대 브라우저에서는 필요하지 않지만, 오래된 코드나 일부 문서에서는 여전히 이러한 형태를 볼 수 있습니다.
정리
간단한 메모에는 // 한 줄 주석을, 긴 설명이나 임시로 비활성화하는 코드 블록에는 /* */ 여러 줄 주석을 사용하는 것이 좋습니다. 적절한 주석 작성 습관은 코드의 가독성을 높이고 협업 시 유지보수를 크게 쉬워지게 만듭니다.