[Javascript] JSDoc이란?

JSDoc

JSDoc은 자바스크립트 API 문서 생성기다. 자바스크립트 소스코드에 JSDoc 형식의 주석을 추가하면 API를 설명하는 HTML 문서를 생성할 수 있다. JSDoc 주석은 /** ... */ 사이에 기술한다.

/**
 * 인자의 합을 구하는 함수
 * @param {number} a 첫번째 숫자
 * @param {number} b 두번째 숫자
 * @returns {number}
 */

function sum(a, b) {
  return a + b;
}

위와 같이 함수 sum위에 JSDoc을 작성하고 sum함수에 커서를 올려보면 다음과 같이 함수에 대해 적어놓은 설명이 나타난다.
sum함수는 어떤 함수인지, 인자 a와 b는 어떤 타입의 데이터여야 하는지, a와 b는 어떤 인자인지 설명이 나타난다.