JS : 주석 작성하는 방법(단일 행 주석, 다중 행 주석, JSDoc)

---

주석은 개발자들끼리 보고 소통하기 위해서 작성하는 것이다.

컴퓨터는 읽지 않아서 (코드로 인식하지 않아서) 출력되지 않는다.

 

Ctrl + / 단축키를 눌러도 주석으로 만들 수 있다.

 

1. 단일 행 주석 (//)

// 주석을 작성하는 방법 입니다.
console.log(); // 코드 옆에 주석 작성 가능

 

2. 다중 행 주석 (/* */)

/*이렇게
여러 줄을 작성할 수 있는데 */

/**
 * 별을 누른 상태로 엔터하면
 * 자동으로 맨 앞에 별이 생깁니다
 * 코드를 설명하는 역할을 합니다
 */

 

JSDoc

위와 같이 /** */ 이렇게 주석을 달아서 코드를 설명하는 경우
설명한 코드 위에 마우스를 올리면 주석으로 작성한 코드 설명을 함께 확인할 수 있다.

/**
 * 이것은 숫자 타입 입니다.
 */
const a = 123;​

위와 같이 작성한 경우 아래와 같이 확인할 수 있게 된다.