JSDoc

[ JSDoc 이란 ]

- Javascript 소스코드 파일에 주석을 달기위해 사용되는 마크업언어이다.

- 즉, Javascript API 문서 작성할 수 있는 기능이다.

- 형식: /** */

- 작성 후 함수 호출할때 자동완성 말풍선에서 해당 Comment 를 보고 참고할 수 있다.

- 타입스크립트에서 잘 사용했는데, 요즘은 라이브러리를 사용하여 Javascript 에서도 자주 사용한다.

 

[ 사용 예 ]

/**
 * 함수 설명 및 기능 안내
 * @param {string} firstParam
 * 
 */

 

 

[ 주요 속성 ]

• param : 함수 파라미터 타입 및 파라미터 설명
  ex) @param {string} address
  
  
• author : 작성자 정보 설명. 
  ex) @author Ddooby <ddooby@gmail.com>
  
  
• copyright : 파일 또는 함수의 개요, 설명에 대한 저작권 설명.
  ex) @copyright <Ddooby company>
  
  
• todo : 예정작업이 있을 경우 표기
  ex) @todo API 추가 되면 작업예정