Jsdoc

JSDoc은 JavaScript 소스 코드에 대한 API 문서를 생성하기 위한 마크업 언어.

정의와 개념

  • JavaScript 코드에 대한 설명을 위해 사용되는 주석 시스템.
  • /** */ 형식의 주석 안에 @로 시작하는 특별한 태그를 사용하여 정보를 제공한다.

주요 특징

  1. API 문서 자동 생성: 주석을 기반으로 HTML 형식의 문서를 생성한다.
  2. 타입 정보 제공: 함수의 매개변수, 반환값 등의 타입을 명시할 수 있다.
  3. 코드 에디터 지원: 많은 IDE에서 JSDoc을 인식하여 자동완성, 타입 체크 등을 제공한다.

주요 태그

  • @param: 함수 매개변수 설명
  • @returns: 함수 반환값 설명
  • @type: 변수의 타입 지정
  • @typedef: 사용자 정의 타입 생성
  • @example: 사용 예제 제공

사용 예시

1
2
3
4
5
6
7
8
9

/**
 * 두 수를 더하는 함수
 * @param {number} a - 첫 번째 숫자
 * @param {number} b - 두 번째 숫자
 * @returns {number} 두 숫자의 합
 */
function add(a, b) {
  return a + b;
}

참고 및 출처

Use JSDoc: Index