코드를 작성하다 보면 설명을 덧붙이거나 특정 코드를 일시적으로 실행하지 않도록 처리해야 할 때가 많습니다. 이때 사용하는 것이 바로 주석(Comment)입니다. JavaScript는 C 스타일과 C++ 스타일의 주석을 모두 지원하며, HTML 주석 문법까지 일부 인식합니다.
JavaScript에서 지원하는 주석의 종류
- 한 줄 주석(//) —
//부터 그 줄의 끝까지 작성된 모든 텍스트는 주석으로 처리되며, JavaScript 엔진이 실행 시 무시합니다. - 여러 줄 주석(/* */) —
/*와*/사이에 있는 텍스트는 모두 주석으로 간주됩니다. 하나의 줄뿐만 아니라 여러 줄에 걸쳐 작성할 수 있어 긴 설명이나 코드 블록 전체를 비활성화할 때 유용합니다. - HTML 주석 시작 기호(<!--) — JavaScript는 HTML 주석 시작 기호인
<!--도 인식하며, 이를//와 동일하게 한 줄 주석으로 처리합니다. - HTML 주석 종료 기호(-->) — 반면 HTML 주석 종료 기호인
-->는 JavaScript가 단독으로 인식하지 못하기 때문에, 반드시 앞에 슬래시를 붙여//-->형태로 작성해야 합니다.
주석 사용 예제
다음 예제는 JavaScript에서 다양한 방식의 주석을 실제로 활용하는 방법을 보여줍니다.
<script> <!-- // 한 줄 주석입니다. C++의 주석과 유사한 방식입니다. /* * JavaScript의 여러 줄 주석입니다. * C 언어의 주석 작성 방식과 매우 흡사합니다. */ //--> </script>
주석 활용 팁
- 복잡한 로직에는 왜 그렇게 작성했는지 이유를 함께 남기면 유지보수에 큰 도움이 됩니다.
- 여러 줄 주석은 함수나 모듈의 설명을 문서화하는 데 자주 활용됩니다.
- 디버깅 중 특정 코드를 임시로 실행하고 싶지 않을 때도 주석 처리를 손쉽게 활용할 수 있습니다.
주석은 프로그램의 실행 결과에는 영향을 주지 않지만, 코드의 가독성과 협업 효율을 높이는 데 필수적인 요소입니다. 상황에 맞게 한 줄 주석과 여러 줄 주석을 적절히 활용해 보세요.