보통 자바스크립트에서 주석을 다는 방식이 3개가 있다. 다음과 어려운 게 아니라, 습관이 중요하니 그냥
바로바로 알아보자.
javascript에서 주석을 다는 3가지 방식
1. 한줄 주석
// 한 줄 주석을 달때는 //를 사용함
2. 여러줄 주석
/* 여러 줄 주석을 달 때
*을 / 사이에 넣음
*/
3. 여러줄 주석 + 명세작성
/**
* 여러 줄 주석을 달 때
* 함수나 클래스에 힌트(명세)를 달 수 있음
*/
위를 보면 한줄 주석은 //로, 여러줄 주석은 /* ... */ 로 작성한다.
근데 3번을 보면 /** ... */ 와 같이 작성하는데 뭐가 다를까?
함수 선언하는 부분의 바로 위에 3번과 같이 작성을 하면 실제로 해당 함수를 호출할 때 이 주석을 확인 할 수 있다.
/** ... */와 같이 주석을 달면 좋은 이유?
위에서 주석을 다는 방법 3가지를 알아보았는데, /** ... */와 같은 방식으로 주석을 달면 좋다.
각 파라메터는 어떤 타입으로 받아야 하는지, 이 함수는 어떤 기능을 하는지를 주석으로 달아놓으면
다른 사용자가 해당 함수를 사용할 때, 해당 주석을 볼 수 있기 때문이다.
샘플코드
/**
* 이름,나이,성별을 인자로 받아 각 인자를 콘솔에 출력하는 함수
* name : 이름(string)
* age : 나이(int)
* sex : 성별(string)
*/
const pringPerson = (name, age, sex) =>{
console.log('이름 : ' + name);
console.log('나이 : ' + age);
console.log('성별 : ' + sex);
}
pringPerson('홍길동', 18, 'man');
샘플로 함수를 선언하고 호출하는 코드이다. name, age, sex 라는 인자를 받아 콘솔에 출력하는 간단한 코드
그리고 그 위에 /** ... */를 이용해서 주석을 달았다. 이렇게만 보면 그냥 함수 위에 주석을 단 것 처럼 보이지만
누군가가 해당 함수를 사용하는데, 이게 어떤 함수인지 알고 싶을 때 함수를 호출하는 코드에 마우스를 올려놓기만 하면
이렇게 해당 함수의 주석을 확인할 수 있다.
아 참고로 이거 .js 파일에서만 된다. html파일의 <script>에서는 안되더라. 다른 방법이 있는건지 모르겠지만
한 30분간 확장팩 설치해보고 뭘 해봐도 안되더라..
본 글은 VScode 기준으로 작성됨. 인텔리제이도 동일한 걸로 알고 있는데
이클립스같은 경우에는 따로 플러그인을 설치해줘야 된다는 것 같다..
