JSDOC 활용해서 아름다운 주석 달기

함수 위에 /** 입력 후 엔터를 치면 아래와 같은 형식이 자동으로 나온다.
@param {} 안에는 입력받길 원하는 타입을 적어둘 수도 있다.

/**
 * 이름, 나이 입력하면 합쳐서 문자로 뱉어주는 함수
 * @param {string} name 이름을 넣어주세요
 * @param {number} age 나이를 넣어주세요
 * @returns 두 값을 합쳐서 String으로 반환합니다
 */
function hello(name, age){
    return name + age;
  }

추가로
@version과
@see를 통해 함수의 버전과 참고 사이트를 지정할 수도 있다.

/**
 * 이름, 나이 입력하면 합쳐서 문자로 뱉어주는 함수
 * @param {string} name 이름을 넣어주세요
 * @param {number} age 나이를 넣어주세요
 * @returns 두 값을 합쳐서 String으로 반환합니다
 * @version 1.3.0
 * @see https://naver.com
 */
function hello(name, age){
    return name + age;
  }

변수 위에나 오브젝트 프로퍼티 위에
@readonly 작성시 읽기전용으로 명시할 수 있다.
@todo로 메모할 수 있다.
@type으로 타입 지정을 할 수 있다.

/**
 * @readonly
 * @type {number|string}
 */
const num = 1;

---

참고자료
자바스크립트 20년차 개발자처럼 주석다는 법