배포 주소
https://min-jeong96.github.io/wanted-pre-onboarding-challenge-fe-2/index.html

---

JsDoc

Block Tags

@Class(@Constructor)

/**
 * 클래스 설명
 * @constructor
 * @type {Object}
 * @property {number} id - 아이디
 * @property {string} content - 내용
 * @property {boolean} completed - 완료 여부
 * @property {string} category - 카테고리
 * @property {string[]} [tags] - 태그들
 */
function Todo(id, content, completed, category, tags) { }

• @typedef를 사용하여 type을 정의하면 Class가 아닌 Global로 docs가 만들어져서 고민하다가 constructor로 만들었다.
• required/optional property는 [<property_name>]으로 작성하면 된다.

참고

• JsDoc 공식 문서
• picpal.log - JSDoc 정리
• 성장 블로그:) - JSDoc를 사용해서 Javasript 문서화해보자!
• JSDoc을 설정 파일로 빼서 사용해보도록 합시다

---

Github Pages 이용해 JsDocs 배포

// package.json
"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "docs": "jsdoc -c jsdoc.json",
  "deploy": "gh-pages -d docs" <- 추가
},

Github Pages 기능을 이용한 배포 방법은 구글링을 통해 쉽게 찾을 수 있다. 다만 npm run docs 명령어 수행 후 만들어지는 jsdoc 정적 페이지는 /docs이므로 package.json에 스크립트 명령어를 추가할 때, 경로를 docs로 지정해주어야 한다.

참고

• 서스포PAR - [GitHub] 깃허브 페이지 + 배포