Compodoc

Compodoc은 Angular 앱 문서화 도구입니다. NestJS에서도 Compodoc이 작동합니다.
Compodoc은 API가 아니라 설치 및 실행 방법, 의존성, 코드의 구조 등을 문서화합니다.

환경 설정

패키지 추가

npm i -D @compodoc/compodoc

package.json 파일 수정

scripts 객체에 아래 코드를 추가합니다.

• -p: ts 설정 파일 경로 지정
• -s: 생성된 문서를 서버에서 제공(지정 안 하면 개별 HTML 파일에서 확인해야 합니다.)
• --port: 포트 지정. 기본값 8080
• --watch: 파일 수정 시 자동 재실행
• -d: 문서 작성 폴더 지정

"doc": "npx @compodoc/compodoc -p tsconfig.json -s --port 8080 --watch -d ./documentation"

사용법

/** */  문서화 주석에 설명을 입력하면 자동으로 문서가 됩니다.

/**
 * UserService 클래스는 User 테이블과 연결됩니다.
 */
@Injectable()
export class UsersService {
  /**
   * findAll() 메서드는 모든 유저를 조회하여 반환합니다
   * @param getUsersParamDto
   * @param limit
   * @param page
   * @returns
   */
  findAll(getUsersParamDto: GetUsersParamDto, limit: number, page: number) {
    return;
  }

  /**
   * findOneById() 메서드는 매개변수로 전달된 ID와 일치하는 유저를 조회하여 반환합니다.
   * @param id
   * @returns
   */
  findOneById(id: number) {
    return;
}

문서화 예시