[JavaScript] JSDoc

JSDoc 이란?

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

💡 Javasript 소스코드 파일에 주석을 달기위해 사용되는 마크업언어

사용방법

/** ... */

위와 같은 형태로 사용해야 합니다. /*, /*** 와 같이 시작하면 해당 코드는 사용이 불가합니다.

주석 설명

document annotation

@version
라이브러리 버전
@file
파일
@copyright
저작권
@license
소프트웨어 라이선스
@author
저자

function annotation

@this
this 가 참조하는 것
@const or @constant
상수
@description
설명
@throws or @exception
에러 및 예외사항
@param or @arg or @argument
파라미터
@callback
callback 으로 받은 정보
@requires
필요한 모듈
@todo
해야할 일
@return or @returns
리턴값

사용예제

/**
 * @param {string} gender 성별
 * @param {string} name 이름
 * @param {number} age 나이
 * @returns {string}
 * @description 이름(성별), 나이를 출력한다.
 */
const info (gender, name, age) => return `${name}(${gender}) , 나이는 ${age}`.;