[Javascript] Javascript에 주석(Comment) 넣기

자바스크립트에서 주석은 html 주석과 다른 형태를 띠고 있다.

한 줄 주석

한 줄 주석은 //로 만든다.

// single line comment

// 앞은 코드로 처리하고, // 뒤는 주석으로 처리한다. 예를 들어

var jb = 'hi'; // Comment

라고 var jb = ‘hi’;는 코드로 인식한다.

여러 줄 주석

여러 줄을 주석으로 만들 때는 /*와 */로 둘러싼다.

/*
  Comment 1
  Comment 2
​*/

읽기 좋게 다음과 같은 모양으로 만들기도 합니다. 내용이 변경되지 않는다고 하면 아래처럼 사용하는것도 괜찮겠지만 Clean Code의 주석 내용을 찾아보면 아래와 같은 주석은 많은 단점을 가지고 있기 때문에 사용하지 않는것을 권장한다.

/*
 * Comment 1
 * Comment 2
​ */

스크립트 내에서 <!-- //--> 사용 이유

오래된 코드의 경우에는 <!-- //-->를 사용하는 이상한 코드를 볼 수도 있다. 아래와 같이 스크립트 안에 html 주석이 있는 경우이다.

<script type="text/javascript">
<!--
 . . . . .
 . . . . .
 . . . . .
//-->
</script>

<!-- -->은 html 주석인데 실제 웹에서 저 안에 내용이 실행되고 있다.

바로 초기 오작동을 막기 위해서이다. 자세히 말하면, 위에서도 언급했듯이 <!-- //--> 이것은 html 주석이다. 따라서 브라우저에서도 일단은 html 주석으로 인식한다. 그러나 javascript 엔진을 내장하고 있는 브라우저의 경우에 <script> 태그 안에 <!-- //--> 있는 내용은 다시 js 소스로 인식한다. 따라서, js 엔진이 없는 경우에 html 주석이 없으면 HTML 파서가 모르는 내용(function, for, if…)들로 인해 브라우저 오류가 발생하는데 이를 방지하기 위해 js 부분을 로 일단 html 주석 처리한다. 하지만 최근 대부분의 브라우저들은 js 엔진을 내장하고 있기 때문에 왠만하면 이것을 사용하지 않아도 된다고 한다.

주의할 점

HTML 문서에 넣은 자바스크립트 주석은 소스보기를 하면 다 보인다. 따라서 개발 과정에서 작성했지만 공개되면 안되는 주석들이 있다면 삭제하는 게 좋다.