JSDOC란 무엇인가

• JavaScript 코드에 annotate를 하기 위한 마크업 언어이다.

• JavasScript Api를 명세하기 위한 용도로 사용된다.

  → 즉 JsDoc는 주로 프로그래밍에 코멘트를 달아서 명세도로 사용하기 위함이다.

• 공식문서에서 제공하는 다양한 annotation을 사용하여 코멘트에서 타입을 명시하여 사용한다.

설정하기

vscode 설정하기

1. Global Setting

   • setting.json에서 다음 설정을 추가한다.

   — "js/ts.implicitProjectConfig.checkJs": true

2. Local Setting

   • type check 하고 싶을 파일 상단에 @ts-check 를 추가한다.

jsdoc 설치하기

• npm i -D jsDoc

jsdoc.json 설정하기

{
  "plugins": [],
  "recurseDepth": 10,
  "source": {
    "includePattern": ".+\\\\.js(doc|x)?$",
    "excludePattern": "(^|\\\\/|\\\\\\\\)_"
  },
  "sourceType": "module",
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc", "closure"]
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  }
}

→ 공식문서에서 제공하는 기본 세팅