React - JSDoc template 👏

지난 포스팅에서 React에 JSDoc를 사용해서 Doxygen을 작성했습니다.
이 포스팅을 읽기 전에 지난 포스팅을 먼저 읽어주세요!
(이 글은 누구나 볼 수 있는 블로그에서 많은 도움을 받아 작성했습니다.)

JSDoc 템플릿

Google에 'npm jsdoc template'나 'jsdoc template'등을 입력하면 다양한 템플릿들을 볼 수 있습니다.
그 중에서 제가 적용할 템플릿은 Minami입니다.

적용하기

1. npm을 이용해서 템플릿을 설치합니다.

$ npm install --save-dev minami

2. package.json 파일의 하단에서 모듈이 설치된 것을 확인합니다.

3. json 설정파일을 만들어줍니다.

index.js와 같은 경로에 설정파일을 만들겠습니다. 설정파일의 이름은 jsdoc.config.json로 작성하겠습니다.

{
    "source": {
        "include": ["./src"] // 이 경로 이하 js, jsx, jsdoc을 대상
    },
    "opts": {
        "encoding": "utf8", // Docs에서 한글을 사용할 수 있도록 설정
        "template": "node_modules/minami" //minami 템플릿 적용
    }
}

4. 템플릿을 적용합니다.

$ ./node_modules/.bin/jsdoc '나의 JavaScriptFile.js'
$ ./node_modules/.bin/jsdoc -c jsdoc.config.json

5. out폴더에서 html을 열어서 생성된 문서를 확인합니다.