JSDoc 란?

📌 JSDoc 란?

일종의 주석 달기 

거의 표준화가 되어서 Vscode, Webstorm 등 에서는 기본으로 기능을 제공

특정 형태로 주석을 달면 해당 주석 내용을 통해 함수의 기능 또는 매개 변수의 타입등을 미리 알려줄 수 있음

주석을 달 때 /** */ 로 달면 됨

 

JSDoc 예시

✅ JSDoc 부가 기능

• @todo 
  • 메모처럼 사용 가능, 개발하다가 멈출때 다음부터 해야할 것 써놓기 

/** 
 * @todo 내일 새로운 매개변수 추가 해야함 due to 10:30 ..
 */

 

• @deprecated
  • 더 이상 해당 기능을 쓰지 않을 때 추가 -> 함수 쓰면 가로줄이 그어짐
• @type {타입 형태}
  • 변수에 특정 타입을 쓰라고 알려 줄 때 사용이 가능
  • 요즘은 typescript가 이 역할을 대신 해줘서 잘 안쓰긴 함 

 

✅ JSDoc 심화 활용

: 함수처럼 정의하고 재사용 

property : object안에 있는 것들

• @typedef
  • JSDoc 의 내용을 변수 처럼 선언해 놓고 다른 곳에서 사용이 가능합니다!
  • @typedef 로 정의된 JSDoc은 @type {} 으로 사용합니다.
  • 정의된 형식과 다를 경우 경고를 띄워 줍니다!

JSDoc 심화 예시

제일 좋은건 JSDoc 없이도 깔끔하고 명확한 코드를 짜는 것 

 

📍만든 데이터는 배열이므로 @type {Post[]} 적용