在node.js

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将始终返回与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() 
}