[NestJS] 자동 문서화 가이드 (Compodoc)
개발자에겐 항상 문서화에 대한 고민이 많을 것이다.개발도 해야하고 테스트도 해야하고 유지보수도 해야하고 할일도 많은데 문서화까지 하라니 아무리 그래도 너무 과한 업무라고 생각이 들 때도 있다.이런 생각을 나만 했던 것은 아닌지 NestJS에서는 기존 Angular 기반의 Compodoc이라는 오픈소스로 아주 쉽게 문서화할 수 있도록 도와주는 패키지가 존재한다.이로써 귀찮았던 문서화나 가이드 등을 좀 더 쉽게 정리할 수 있을 것이다.1. 패키지 설치npm i -D @compodoc/compodoc2. compodocrc.json 추가{ "includes": "./src", "includesName": "프로젝트 문서", "name": "프로젝트명 API 문서", "output": "d..
2025. 5. 30.
최근댓글