웹개발 및 최신 테크 소식을 전하는 블로그, 웹이즈프리
자바스크립트에서 주석 사용 방법에 대하여 알아봅니다.
# 자바스크립트 주석(comment) 알아보기
자바스크립트 뿐만 아니라 주석의 사용은 매우 중요한 역할을 합니다. 단순히 코드를 실행하지 않는 용도로만 사용하지 않고 다양한 기능으로 사용되기 때문입니다. 그럼 주석은 언제 사용할까요?
- 특정 기능을 실행하지 않기 위함
- 주석에 설명을 남겨두기 위한 목적
- 에러를 찾거나 특정 기능만 수행하기 위한 목적
이처럼 다양한 목적으로 사용할 수 있습니다. 여기서 '특정 기능을 실행하지 않기 위함' 이라고 적혀 있는 부분을 생각해 보겠습니다. 필요가 없는 코드일 수도 있겠지만 현재 사용되지 않더라도 나중에 사용될 여지가 있는 부분이거나 현재는 지원되지 않지만 향 후 에는 지원되는 등 여러가지 이유가 있을 수 있습니다. 또 인수인계의 목적으로 다른 개발자에게 전달하기 위한 목적이 될 수도 있겠죠.
! 자바스크립트의 주석 사용
왜 필요한지를 알아보았고 아래는 어떻게 사용하는지 알아봅니다. 다른 언어와 비슷하게 자바스크립트는 두 가지 방식의 주석 설정이 가능합니다. 바로 한 줄 주석(Line comment) 그리고 블록 주석(Block comments)입니다.
블록주석 /* */
@ 한 줄 주석 보기
removeAll = function() {
// Remove all elements
...
}
// Remove all elements
...
}
위 예제는 removeAll() 함수가 어떤 동작을 하는지 간략하게 주석으로 남겨두었습니다. 일반적으로 함수 동작은 블록 주석으로 설명되지만 내부의 간략한 설명이나 부수적인 것들은 이처럼 한 줄 주석이 사용되기도 합니다.
다음은 블록 주석입니다. 사실 쓰임이 가장 많은 주석이 바로 블록 주석입니다. 일단 적은 코드로 블록 전체를 주석 처리 할 수 있기 때문이고 블록 주석 역시 한 줄 주석처럼 사용할 수도 있기 때문입니다.
@ 블록 주석 보기
/**
* Remove all elements
* @param { Number } maxCount
*/
removeAll = function(maxCount) {
...
}
* Remove all elements
* @param { Number } maxCount
*/
removeAll = function(maxCount) {
...
}
블록 주석은 위와 같이 쓰입니다. 기능을 정의하기도 하지만 특정 기능만 동작시키기 위한 디버깅이나 테스트 목적으로도 매우 많이 사용됩니다. 일반적으로 주석 사용에 대한 단축키 설정만으로 사용되죠. 대부분의 IDE에서 주석 설정의 단축키 역시 많이 쓰입니다.
여기까지 자바스크립트의 주석 사용에 대하여 알아보았습니다.
! 마치면서
참고로 자바스크립트라고 해도 React나 기타 다른 프레임워크나 환경에서는 주석 사용 방법이 다를 수 있습니다.
주석이 중요한 이유를 추가적으로 말해보면 코드 작성시 주석을 사용하지 않는 개발자는 거의 없습니다. 나중에 할 일이나 해야 할 일들을 TODO 형태의 주석으로 먼저 남기고 개발하는 것도 주석 사용의 활용 방법 중 하나입니다.
아래의 글도 찾고 계시지 않나요?
