JSDoc과 사용법

유림·2022년 8월 29일
0

💡dding's TIL

목록 보기
13/41
post-thumbnail

[JSDoc]

  • 주석을 고급 개발처럼 보이게 달아주는 기능 : '/** */'형태
  • 협업할 때 라이브러리, 코드에 대해 jsdoc를 통해 자세히 설명해 놓는 것을 권장
  • 아래와 같이 주석을 작성해주게 되면 나중에 해당 함수를 작성할 때 'hello'함수에 mouseover만 해도
    어떻게 사용하는 함수인지 설명이 뜬다

jsdoc 사용할 수 있는 타입들

  • @todo : 어디까지 작성했는지 적어놓을 수 있음
  • @deprecated : 앞으로 사용하지 않는 함수를 표시하기 위해 (아예 삭제하기엔 위험이 있기 때문)
  • @type{타입형태} : 단, 이 부분은 타입스크립트로 전환되고 있기 때문에 거의 사용하지 않음

- 재사용 가능

  • @typedef : post라는 jsdoc를 여러번 사용할 수 있음
  • 만약 여러 객체가 들어있을 경우 typedef에 표시해줘야함
    배열이기 때문에 post뒤에 []붙여주기
profile
ɪ ʜᴏᴘᴇ ᴛᴏ sᴏʟᴠᴇ ʀᴇᴀʟ ᴘʀᴏʙʟᴇᴍs👩🏻‍💻❤️

0개의 댓글