javascript - 记录返回方法调用的方法的最佳方式

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

---

想要改进这个问题吗？更新问题，以便 editing this post 可以用事实和引文来回答它。 .

已关闭 5 年前。

Improve this 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 的文档，说明此方法是包装器，或者返回 sumTwoNumbers 函数返回的输出.

从 sumTwoNumbers 函数中复制相同的抛出和返回。最后为 sum 函数添加下一个注释 @see 标记，它指向 sumTwoNumbers。

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