문서화 라이브러리 추천 (Recommend Angular Documentation Tool - compodoc)

Angular에 JSDoc과 같은 자동 문서화 라이브러리를 사용하고자 하실 것입니다.

이번에 소개해드릴 라이브러리는 compodoc 입니다.

Angular Routing 방식을 잘 이해하며, Lazy Loading도 이해하여 문서를 작성해주며, 모듈에서 호출한 component의 구조. component에서 사용된 변수와 함수 등등 상세히 정리해 주어 거의 완벽한 문서를 자동으로 만들어 줍니다.

설치

  npm install @compodoc/compodoc --save

실행

tsconfig.app.json의 경로를 입력합니다.

  npx compodoc -p src/tsconfig.app.json

공식 문서에서는 npm 6 버전이상이면 package.json에 등록해놓고 쉽게 사용하도록 안내하고 있습니다.

  "scripts": {
        "compodoc": "npx compodoc -p src/tsconfig.app.json"
  }

  npm run compodoc

업데이트 2021.7.12

• Lazy Loading 오류 문제가 해결되었습니다.
• 그러나 Lazy Loading에서 아래와 같이 routes에 async await을 적용한 방식은 아직 에러가 발생합니다.

  {
    path: 'test',
    loadChildren: async () =>
      await (import('/test/test.module')).TestModule
  },
  

참고 사이트

• github compodoc
• compodoc site