JSDoc 레퍼런스 해부하기 - 1

참고 링크

https://jsdoc.app/

Use JSDoc: Index

 

Getting Started with JSDoc 3

 

JSDoc 3 (최신버전) 이란?

- JavaScript를 위한 API 문서 생성기

- 소스코드에 직접 코멘트를 추가할 수 있음

- 소스코드를 스캔하고 HTML 문서 웹사이트를 생성해준다

 

상세

- JSDoc 주석은 소스코드 바로 직전에 위치해야 한다

- 각 주석은 JSDoc Parser가 인식할 수 있도록 /** 로 시작해서 */ 로 끝나야 한다

 

- 예시1 간단한 설명 : 무엇에 대한 설명인지 정의

 

/** This is a description of the foo function. */
function foo() {
}

 

- 예시2 @를 활용한 상세 설명

@constructor 태그를 통해 생성자 함수를 표시

@param {타입} 변수명 : 변수를 상세히 설명

 

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
function Book(title, author) {
}

 

웹사이트 생성

- JSDoc 3 tool을 활용해 소스코드로부터 HTML 웹사이트를 만들 수 있다

- default 템플릿이 기본적으로 적용되며 템플릿 수정도 가능하다

- `jsdoc 파일명` 커맨드 명령을 통해 out 디렉토리가 만들어지고, 이 안에서 HTML 파일을 확인할 수 있다