Compodoc에서 Angular 문서를 생성해보십시오.

Compodoc이란?

Compodoc 은 Angular 문서를 명령만으로 자동 생성해 주는 편리한 패키지입니다. 일반적인 다큐멘테이션에 가세해, 컴퍼넌트등의 상관도나 DOM 트리등의 한눈에 아는 그림도 생성 커멘드 하나로 해 줍니다. 참고로 공식 샘플 그림을 게시합니다.

설치해 보았습니다.

공식 설치 가이드에서는 npm을 사용하고 있지만 yarn의 경우도 터미널에서yarn add "@compodoc/compodoc"를 입력하면 설치가 완료됩니다. 또한 packege.json에

//package.json
//tsconfig.app.jsonのディレクトリパスは自分のものを適用してください

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

를 추가하면 npm run compodoc 또는 yarn compodoc 명령을 실행하기만 하면 문서가 생성됩니다. 자신의 환경에서는 상기와 같이 해도 main.ts 밖에 인식되지 않고 컴퍼넌트등은 무시되어 버렸으므로, tsconfig.app.json 대신에 tsconfig.json 에 패스를 통과하면 정상적으로 생성되었습니다.

또한 서버 시작compodoc -p src/tsconfig.json -s 명령을 사용할 수 있습니다. 기본 주소는 http://localhost:8080입니다. 예를 들어 npx compodoc -p ./tsconfig.json -s -r 9000 명령을 사용하여 포트 지정을 변경하여 http://localhost:9000로 설정할 수도 있습니다.

댓글과 태그 정보

생성하기 위한 코멘트의 방법은 특히 다른 언어의 것과 다르지 않다고 생각합니다.

/**
 * supported comment
 */


/*
 * unsupported comment
 */


/*
  unsupported comment
 */


// unsupported comment

태그는 공식 페이지을 참조하십시오. JSDoc 태그 중 전부를 사용할 수 있는 것은 아니기 때문에, 사용하는 사람에 따라서는 TypeDoc 쪽이 좋을지도 모릅니다.