JavaScript에서 /*...*/와 /**...*/ 주석의 차이점은 무엇일까요?

JavaScript에서 /*...*/와 /**...*/는 모두 여러 줄 주석(multi-line comment)입니다. 두 표기법은 문법적으로 동일하게 동작하지만, /**...*/ 형식은 자동 문서화 도구를 위한 특수한 용도로 사용된다는 점에서 차이가 있습니다.

여러 줄 주석 /*...*/

JavaScript의 여러 줄 주석은 C 프로그래밍 언어의 주석 스타일과 매우 유사합니다. 아래와 같이 작성합니다.

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

HTML 문서 내에서의 사용 예시

실제 웹 페이지에서 여러 줄 주석을 사용하는 예시는 다음과 같습니다.

<script>
    <!--
        /*
         * 이것은 JavaScript의 여러 줄 주석입니다
         * C 프로그래밍 언어의 주석과 매우 유사합니다
         */
    //-->
</script>

주석 /**...*/의 특별한 용도

/**...*/ 형식의 주석은 원래 PHPDocumentor(구 PHPDocumentator)를 위해 고안된 것으로, 소스 코드로부터 자동으로 문서를 생성하는 데 사용됩니다.

JavaScript 진영에서도 같은 형식을 JSDoc이라는 문서화 도구가 채택하고 있습니다. 함수나 변수 위에 이 형식으로 설명을 작성해 두면, 도구가 이를 인식하여 자동으로 API 문서를 만들어 줍니다.

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

정리

• /*...*/와 /**...*/는 모두 여러 줄 주석이며, 실행 시 자바스크립트 엔진이 무시합니다.
• /**...*/는 일반 주석이 아니라 PHPDocumentor나 JSDoc 같은 문서화 도구가 인식하는 특수 주석으로, 자동 문서 생성에 활용됩니다.
• 따라서 기능상 차이는 없지만, 코드 문서화를 위해서는 /**...*/ 형식을 사용하는 것이 좋습니다.