javascript jsdoc에서 일반 변수가 아닌 json object를 표현하는 방법

프로그래밍에서 주석은 정말 중요합니다.

주석을 잘 써놓으면 정말 도움이 많이 됩니다.

오픈소스 라이브러리를 사용할 때나, 다른 사람과의 협업에서도 주석을 보며 일을 합니다.

/**
 * 숫자를 더한다.
 * @param number1 숫자 1
 * @param number2 숫자 2
 * @returns {*} 숫자1 + 숫자 2
 */
function plus(number1, number2) {
  return number1 + number2;
}

이런 코드와 주석이 있다면 이 함수를 사용하는 부분에서 아래처럼 표시가 됩니다.

javascript jsdoc에서 일반 변수가 아닌 json object를 표현하는 방법

 

object 형태의 파라미터(매개변수)를 표현하는 방법은 여러 가지가 있습니다.

 

방법 1.

/**
 * 두개의 숫자를 더한다.
 * @param json
 * @param json.number1 첫번째 숫자
 * @param json.number2 두번째 숫자
 * @return {*} 숫자1 + 숫자2
 */
function plusNumber(json) {
  return json.number1 + json.number2
}

 

이 함수는 다음과 같이 표시됩니다.

javascript jsdoc에서 일반 변수가 아닌 json object를 표현하는 방법

 

 

방법 2.

/**
 * 두개의 숫자를 더한다.
 * @param {{number1: 숫자, number2: 숫자}} obj
 * @return {*} 숫자1 + 숫자2
 */
function plusNumber(obj) {
  return obj.number1 + obj.number2
}

 

이 함수는 다음과 같이 표시됩니다.

javascript jsdoc에서 일반 변수가 아닌 json object를 표현하는 방법

 

 

방법 3.

/**
 * 두개의 숫자를 더한다.
 * @param {Object} obj
 * @param {number} obj.number1 숫자1
 * @param {number} obj.number2 숫자2
 * @return {*} 숫자1 + 숫자2
 */
function plusNumber(obj) {
  return obj.number1 + obj.number2
}

 

이 함수는 다음과 같이 표시됩니다.

 

 

방법 4. return도 object를 사용할 수 있습니다.

/**
 * 두개의 숫자를 더한다.
 * @param {Object} obj
 * @param {number} obj.number1 숫자1
 * @param {number} obj.number2 숫자2
 * @return {Object.<string, number>} 숫자1 + 숫자2
 */
function plusNumber(obj) {
  return {
    "sum": obj.number1 + obj.number2
  }
}

 

다음과 같이 표시됩니다.

 

 

 

출처: https://stackoverflow.com/questions/6460604/how-to-describe-object-arguments-in-jsdoc