JSDoc typedef 在一个单独的文件中

Question

我可以在单独的文件中定义所有自定义类型(例如 types.jsdoc )，以便可以在整个应用程序中重用它们吗？正确的方法是什么？

/**
 * 2d coordinates.
 * @typedef {Object} Coordinates
 * @property {Number} x - Coordinate x.
 * @property {Number} y - Coordinate y.
 */

Answer 1

您可以在模块中定义类型(例如 typedefs.js )。该模块包含您的 JSDoc 类型定义，并且可以简单地导出未使用的属性。

// typedefs.js
/**
 * @typdef foo
 * @property {string} bar
 */

// etc.

exports.unused = {};

要使用它，请在需要引用这些 typdef 的地方导入模块:

const typedefs = require("./typedefs");
/** @type {typedefs.foo} */
const fb = { bar: "hello" };

不妨注释 typedefs.js作为 @module或 @namespace .因为我使用“tsd-jsdoc”来生成 types.d.ts文件，并且由于 TypeScript 现在解释模块与命名空间的方式，我已经注释了我的 typedefs.js文件为 @namespace并将每个 typedef 记录为该命名空间的成员:

/**
 * @namespace typedefs
 */

/**
 * @typedef foo
 * @property {string} bar
 * @memberof typdefs
 */

希望有帮助。