Question

查看当前示例：

/**
@param {int} first number
@param {int} second number
@throws ?????
@returns ??????
*/
function sum(numberOne, numberTwo) {
  return sumTwoNumbers(numberOne, numberTwo);
}

/**
@param {int} first number
@param {int} second number
@throws {error} error
@returns {int} number
*/
function sumTwoNumbers(numberOne, numberTwo) {
  if (!Number.isInteger(numberOne)) {
    throw new Error('argument must be integer');
  }
  return numberOne + numberTwo;
}

sum(1, 2);

在函数和

中应该包含@throws和@returns注释

Answer 1

首先添加函数sum的文档说，此方法是包装器，或返回sumTwoNumbers函数返回的输出。 < / p>

从sumTwoNumbers函数复制throws和returns。最后为sum函数 @see 标记添加下一个注释，该标记指向sumTwoNumbers。

@throws error    //if thrown by sumTwoNumbers
@returns number
@see {@link sumTwoNumbers}

记录返回方法调用的方法的最佳方法

1 个答案: