본문 바로가기 메뉴 바로가기

Algoroot's space

프로필사진
  • 글쓰기
  • 관리
  • 태그
  • 방명록
  • RSS

Algoroot's space

검색하기 폼
  • 분류 전체보기 (118)
    • Python (2)
    • Frontend (4)
      • NextJS (2)
      • React (9)
      • React-native (8)
      • Typescript (0)
      • JavaScript (18)
      • Html&CSS (5)
      • Projects (5)
      • JASON (1)
      • ToyProject (6)
    • git (10)
      • monorepo (2)
      • action (0)
    • Network (6)
    • 알고리즘 (26)
      • 백준-BACKJOON (4)
      • 프로그래머스-Programmers (17)
      • leetcode (1)
      • 자료구조 (4)
    • 회고 (5)
    • Server (1)
    • 항해99 (5)
    • CS (Computer science) (10)
  • 방명록

api documenter (1)
[귀찮은건 질색이야-2] 나는 코드를 작성했는데 문서가 생성된다고?: api-extractor (feat. Docusaurus, Github A

안녕하세요. 오늘은 코드와 주석을 기반으로 문서 자동화한 경험을 공유하고자 합니다. 보일러플레이트에서 응집되어 있던 utils, hooks을 용도에 맞게 패키지로 분리하면서, 관리적과 성능적으로는 이점이 있었지만, 실무진 분들이 어떠한 함수를 가져오기 위해 참고할 수 있는 문서가 필요했습니다. 21개가 넘는 패키지들, 총 100개는 넘을 듯한 컴포넌트나 함수들을 개발하는 것을 떠나서 또 문서작업을 해야 한다는 게 굉장히 부담으로 다가왔습니다. 따로 md파일을 생성하여 관리하는 것이 아닌, 명령어만으로 문서가 자동생성 되게 하면 얼마나 편할까요? 다행히도, 아주 다행이도 이미 잘 개발된 라이브러리를 발견했습니다. 바로 MicroSoft 에서 개발한 오픈소스도구인 api-extractor인데요. 해당 ..

Frontend 2024. 12. 20. 00:07
이전 1 다음
이전 다음
공지사항
최근에 올라온 글
최근에 달린 댓글
Total
Today
Yesterday
링크
TAG
  • html
  • javascript
  • 모두를위한컴퓨터과학
  • 자바스크립트 비동기 처리
  • React
  • 알고리즘자바스크립트
  • 리액트네이티브
  • 리액트
  • 실전프로젝트
  • 항해99
  • cs50
  • 클로저
  • 무한스크롤
  • css
  • 자바스크립트 클로저
  • 프로그래머스 자바스크립트
  • GIT
  • 프로그래머스 베스트앨범 자바스크립트
  • 네트워크
  • 모두를 위한 컴퓨터 과학
  • python
  • 백준
  • 자바스크립트
  • 타입스크립트
  • network
  • 프로그래머스
  • reactquery
  • github
  • 자바스크립트알고리즘
  • React Query
more
«   2025/05   »
일 월 화 수 목 금 토
1 2 3
4 5 6 7 8 9 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28 29 30 31
글 보관함

Blog is powered by Tistory / Designed by Tistory

티스토리툴바