문서화

문서화 도구

• ESDoc
  • ES6+ 지원
  • 타겟 : ES6 class와 import/export 스타일
  • 자세한 문서를 생성해줌
  • 문서화 커버리지 확인
    • 커버리지 확인 호스팅서비스/뱃지 제공
  • 테스트 코드/메뉴얼 통합 기능
  • 메뉴얼 인덱스 : 마크다운 작성
  • 사용방법 작성 : 마크다운 작성
• JSDoc
  • ES3/ES5/ES6 지원
  • 타켓 : 클래스 기반 OOP와 프로토타입 기반 OOP
  • 많은 유용한 문서 태그 지원
  • JSDoc과 ESDoc 차이
• Inch CI
  • 계정/저장소명을 입력하면 자동으로 문서화의 커버리지를 알려준다.
• dtc-gen
  • javascript를 TypeScript로 만들어 주는 도구