JavaScript 주석의 종류와 사용법 완벽 정리

JavaScript에서 주석(Comment)은 코드 실행에 영향을 주지 않으면서 개발자가 설명이나 메모를 남길 수 있게 해주는 중요한 도구입니다. 코드의 가독성을 높이고 협업 시 의사소통을 원활하게 만들어 주며, 디버깅 중 특정 코드를 일시적으로 비활성화할 때도 활용됩니다.

1. 한 줄 주석 (Single-Line Comment)

한 줄 주석은 //로 시작하며, 해당 기호부터 줄 끝까지의 모든 텍스트는 JavaScript 엔진에 의해 무시됩니다. 간단한 설명이나 짧은 메모를 남길 때 가장 많이 사용되는 방식입니다.

// 이것은 한 줄 주석입니다. C++의 주석과 유사합니다.

2. 여러 줄 주석 (Multi-Line Comment)

여러 줄 주석은 /*로 시작해서 */로 끝나며, 그 사이에 있는 모든 내용이 주석으로 처리됩니다. 여러 줄에 걸친 긴 설명을 작성할 때 유용하며, C 언어 계열 프로그래밍 언어의 주석과 매우 비슷합니다.

/*
 * 이것은 JavaScript의 여러 줄 주석입니다.
 * C 언어의 주석과 매우 유사합니다.
 */

참고: 문서화 주석 (JSDoc)

실무에서는 함수나 변수에 대한 상세한 설명을 남기기 위해 /** ... */ 형식의 JSDoc 스타일 주석을 사용하기도 합니다. 이 방식은 IDE에서 자동 완성 및 타입 힌트를 제공받을 수 있어 개발 생산성을 크게 높여줍니다.

/**
 * 두 숫자를 더하는 함수
 * @param {number} a - 첫 번째 숫자
 * @param {number} b - 두 번째 숫자
 * @returns {number} 두 숫자의 합
 */
function add(a, b) {
  return a + b;
}

마무리

주석은 코드 자체를 대체할 수 없습니다. 좋은 주석은 '왜' 그렇게 작성했는지를 설명하는 데 집중해야 하며, 과도한 주석은 오히려 가독성을 해칠 수 있습니다. 적절한 위치에 명확한 주석을 활용하면 유지보수성 높은 코드를 작성할 수 있습니다.