728x90
JSDoc이란?
JSDOC은 Javascript 소스코드 파일에 주석 용도의 마크업 언어입니다.
주석이기 때문에 코드에 영향을 주지 않습니다.
빨간 박스 안에 있는 부분이 JSDoc입니다.
// 스크린샷 기준으로 맨 윗 줄인 해당 문구를 통해 props의 자료형이 object임을 알려주고 있습니다.
@param {object} props
// 해당 구문을 통해서는 props.align에 어떤 속성들이 있는지 알려주고 있습니다.
@param {'right' | 'center' | 'left' } props.align
아래 첨부사진과 같이 JSDoc에 param들에 커서를 두면 프로퍼티 목록을 제공합니다.
저는 타입과 프로퍼티를 가이드하옂 가독성을 높여 유지보수를 수월하게 하는 도구로 사용하고 있습니다.
공식 문서에 더욱 많은 태그들을 소개하고 있으니 참고하여 사용하길 추천드립니다.
728x90
'Basic > JavaScript' 카테고리의 다른 글
| [JavaScript] 나머지 매개변수 - 함수 인수 유동적으로 받기 (0) | 2023.04.02 |
|---|---|
| [JavaScript] 문자형(string) 실수(숫자) 데이터, 세자리마다 콤마 구현하기 (0) | 2023.03.30 |
| [JavaScript] 생성자(constructor)로 객체 생성하기 (0) | 2022.08.01 |
| [JavaScript] 객체(Object)의 접근, 요소 추가 (0) | 2022.07.31 |
| [JavaScript] var Hoisting(호이스팅) - var 선언을 주의하세요 (0) | 2022.02.22 |