자바스크립트 JSDoc 함수에 주석 달기

JSDoc

자바스크립트 문서화 도구, js 파일 내 주석을 사용하여 코드를 작성하고 인터페이스를 설명하는 문서를 생성할 수 있다.

(요즘 대부분의 에디터들은 JSDoc 기능을 기본으로 제공해준다.)

/** 인사말을 출력하는 함수*/
function hello(name) {
    alert(`안녕하세요! ${name}님`);
}

 

위의 사진과 같이 함수에 대한 설명이 뜬다.

 

/**
 * 인사말을 출력하는 함수
 * @param {string} name 이름
 */
function hello(name) {
    alert(`안녕하세요! ${name}님`);
}

hello("kiki")

• 함수 위에서 /** 엔터를 치면 jsdoc 주석이 자동완성된다.
• @param {}중괄호는 권장하는 타입을 적어줄수 있다.