jsdoc - 如何让@borrows 标签在 JSDoc 中工作

Question

我一直很难让 @borrows 标记在 JSDoc 中工作。我一直在尝试从一个函数中获取文档，并将其作为第二个函数的文档。但我似乎连一个简单的例子都做不到!

/**
 * This is the description for funcA
 */
var funcA = function() {};

/**
 * @borrows funcA as funcB
 */
var funcB = function() {};

我期待这会输出两个功能完全相同的文档。然而，只有 funcA 只有一个描述。

Answer 1

@borrows标记似乎不能直接作用于符号，而只能间接作用。例如我有:

/** does amazing things */
function origFunc = function() {};

/**
 * @borrows origFunc as exportedFunc
 */
exports.exportedFunc = origFunc;

但我和你一样，在生成的文档中没有任何用处。

那是因为，似乎 @borrows标签对容器进行操作。 (如果您在示例中注意到 @borrows 标签位于“util”模块/命名空间，而不是重命名的符号。)

所以这对我有用:

/** does amazing things */
function origFunc = function() {};

/**
 * @borrows origFunc as exportedFunc
 */
exports = {
  exportedFunc: origFunc,
}

似乎是 @borrows 中的一个错误尽管。 (或者至少是文档中的一个错误。)