JavaScript의 주석(Comment)


JavaScript의 주석 (Comment)

우리는 이미 자바스크립트에서 숫자나 문자를 작성하는 것을 해봤어요! 심지어 가장 중요한 사칙연산인 더하기도 해봤죠.

이제 우리의 프로그램에 주석을 남기는 방법에 대해 알아볼거에요. 주석은 말 그대로 실행되지 않는 문장을 프로그램의 코드에 남겨놓는 방법이에요.

지금까지 우리가 작성한 helloworld.js 파일은 이렇죠.

console.log("hello world");

이제 아래처럼 우리 코드를 주석으로 만들어 봅시다.

// console.log("hello world");

저장하고 다시 Node를 통해서 helloworld.js 파일을 실행해 보세요.

아무런 문장도 출력되지 않고 새로운 프롬프트만 생기네요. 그러면 된겁니다. 즉, 우리가 console.log() 문장을 주석처리 했기 때문에 해당 문장은 그저 주석으로만 남겨지는 거죠.

한줄 주석은 위에서 처럼 // 로 표현해서 만들수 있어요. 줄의 어디서든지 // 이후의 문장은 주석이 되어 실행되지 않아요.

여러줄 주석도 만들수 있어요. 여러줄 주석은,

/* 
console.log("hello world");
console.log(1 + 1);
*/

위 코드 처럼 /* */ 로 주석 처리할 부분을 감싸면 되요.

주석은 다양한 이유로 사용해요.

위의 코드 처럼, 실행시키고 싶지 않은 문장이 있을 경우에 주석으로 처리하면 실행 시키지 않을 수 있죠. 나중에 코드를 작성하면서 이런저런 테스트를 해볼 때 꼭 필요하게 됩니다.

그리고, 사실 제가 좀 멍청하거든요. 기억력이 엄청 나쁘죠. 그래서 코드를 작성할 때 주석을 꼭 남겨 놓아요. 이 코드가 뭐하는 코드인지 코멘트를 남겨 놓지 않으면 나중에 이게 무슨 코드인지 한참을 봐야 알 수 있거든요.

그래서 다른 사람들과 함께 일할 때에도 주석은 꼭 남겨야 해요. 내가 작성한 코드에 대해 설명을 적어 놓아야 다른 사람도 그 주석을 보고 코드를 쉽게 이해할 수 있거든요. 여기서 다른 사람은 자기 자신도 포함되요. 몇일 혹은 몇개월 후의 자기 자신이죠. 장담하는데 주석을 남겨 놓지 않으면 몇개월 뒤에 코드를 보고 이해하는데 훨씬 많은 시간이 걸릴거에요.

// 콘솔에 Hello World를 출력
console.log("Hello World");

/* 사실 console.log 같은것 까지 주석을 남길 필요는 없어요.
주석은 클래스나, 함수, 의외의 선택을 한 문장 등에 남겨요. */