从另一个文件导入 JSDOC 文档

Question

如何在文件 B 中导入类 foo 的文档？

// FileA.js
/** This is a class */
class foo { }

export default objectThatContainsFoo // foo isn't directly exported

// FileB.js
/** @typdef {--IMPORT DOCUMENTATION FOR foo--} foo */

/**
 * @param {foo} foo - This is a foo
 */
function bar(foo) { return true }

Answer 1

所以最终为我工作的一种方法是在源文件中创建一个快速的typedef ，然后可以导入。

// FileA.js

/** @typedef {foo} foo */

/** This is a class */
class foo { }

export default objectThatContainsFoo // foo isn't directly exported

// FileB.js
/** @typdef {import("FilaA.js").foo} foo */

/**
 * @param {foo} foo - This is a foo
 */
function bar(foo) { return true }

现在可以在 FileB 中看到 foo 的属性和描述