JSDoc

JSDoc을 사용하면 자바스크립트 소스코드에 타입 힌트를 제공할 수 있다.
JSDoc 주석은 /** ... */ 사이에 기술한다. 
일반적인 자바스크립트 주석 /* ... */은 무시된다.
TypeScript를 사용하는 것처럼 타입을 추론하고 디버깅을 쉽게 할 수 있다는 장점이 있다.
코드에 맞는 JSDoc 태그의 사용법은 https://jsdoc.app/ 에서 볼 수 있다.

 

변수

/** @type {string} */
let str;

/** @type {number} */
let num;

/** @type {boolean} */
let bool;

/** @type {*} */
let any;

/** @type {?} */
let unknown;

/** @type { {id: number, content: string, completed: boolean} } */
let obj;

/** @type {number[]} */
let nums;

 

함수

/**
 * 두 수의 차를 구한다.
 * @param {number} a - the first thing
 * @param {number} b - the second thing
 * @returns {number}
 */
 const subtract = (a, b) => a - b;
 
/**
 * @param {string}  p1 - A string param.
 * @param {string=} p2 - An optional param (Closure syntax)
 * @param {string} [p3] - Another optional param (JSDoc syntax).
 * @param {string} [p4="test"] - An optional param with a default value
 * @return {string} This is the result
 */
function stringsStringStrings(p1, p2, p3, p4) {
  // TODO
}

 

마우스를 갖다대면 아래와 같이 나타난다.