记录 returns 方法调用的方法的最佳方法

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);

函数sum

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

Answer 1

首先添加函数sum的文档说，这个方法是一个包装器，或者returns returns[返回的输出=12=]函数。

从 sumTwoNumbers 函数中为 throws 和 returns 复制相同的内容。最后为sum函数添加下一个注解@see标签，指向sumTwoNumbers。

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

记录 returns 方法调用的方法的最佳方法

Best way to document method which returns method invocation

javascript

documentation

jsdoc