在 node.js 中引用文档 @return 语句

Question

我们在这里只谈代码文档。

假设有两个函数，f1 和 f2:

/**
 * @return {Boolean} always true
 */
const f1 = () => true;


/**
 * @return {Boolean} always true
 */
const f2 = () => {
  console.log('friendly wrapper of f1()');
  return f1();
};

显然，f2 将始终 return 与 f1 相同的值。因此，他们可能应该得到相同的 @return 描述。

有没有办法将第一个 @return 语句引用到第二个语句中，这样就不会重复任何评论？

我希望像 @return $f1->@return 这样简单，但更正确:)

Answer 1

您可以使用 @see 标签：

/**
 * @return {Boolean} always true
 */
const f1 = () => true;


/**
 * @see f1
 */
const f2 = () => {
  console.log('friendly wrapper of f1()');
  return f1();
};

跨文件示例：

############ FILE 1 ############    

/**
* @module myModule
*/

/**
 * @return {Boolean} always true
 */
const f1 = () => true;


/**
 * @see {@link module:myModule~f1}
 */
const f2 = () => {
  console.log('friendly wrapper of f1()');
  return f1();
};

module.exports = f2

########## FILE 2 ################

var f2 = require('myModule');

/**
* @requires module:myModule
* @see {@link module:myModule~f2}
*/

const f3 = () => {
    return f2() 
}

在 node.js 中引用文档 @return 语句

referencing the documentation @return statement in node.js

javascript

jsdoc

在 node.js 中引用 *文档* @return 语句

referencing the *documentation* @return statement in node.js

javascript

jsdoc

在 node.js 中引用文档 @return 语句

referencing the documentation @return statement in node.js