JSDoc

J·2022년 9월 12일

JSDoc이란?

자바스크립트 소스 코드 파일들에 주해를 달기 위해 사용하는 마크업 언어이다.
자바스크립트에 타입 힌트를 제공할 수 있다.
JSDoc 주석은 /** ... */ 사이에 기술한다.

author은 항목의 작성자를 나타낸다.
이름 뒤에 꺾쇠를 넣고 이메일을 추가한다.

/**
 * @author Brad Pitt <brad@example.com>
 */

function MyClass(){}

매개변수의 이름과 타입, 설명 등을 제공한다.

/**
 * @param {string} somebody - Somebody's name.
 */

function sayHello(somebody){
    alert('Hello ' + somebody);
}

매개변수 somebody의 타입은 string이며, 'Somebody's name.'의 추가 설명을 제공하는 예제이다.
VSCode와 같은 코드 편집기에서 해당 함수 호출 시 힌트를 확인할 수 있다.

해야할 작업을 나타낸다.

/**
 * @todo Write the documentation.
 * @todo Implement this function.
 */

function foo(){
    //write me
}

버전을 나타낸다.

/**
 * @version 1.2.3
 */

function func(a, b){
    return b / a;
}

이 외에도 공식 문서에서 여러가지를 더 소개하고 있다.

J-Web