首页 > 解决方案 > JSDoc 内联对象类型定义

问题描述

有没有一种方法可以编写一个复杂对象的 typedef 内联对象键而不是全部在一个块中?例如,根据 JSDoc 文档https://jsdoc.app/tags-property.html,可以这样:

/**
 * Config type definition
 * @typedef {Object} Config
 * @property {string} prop1
 * @property {string} [prop2]
 */
let Config = {
     prop1: 'value1',
     prop2: 'value2',
};

变成这样:

/**
 * Config type definition
 * @typedef {Object} Config
 */
let Config = {
     /** @property {string} prop1 */
     prop1: 'value1',
     /** @property {string} [prop2] */
     prop2: 'value2',
};

我已经尝试了各种标签组合,例如@namespace、@typedef、@member、@memberof 等,但我无法获得在一个 JSDoc 块中声明所有属性表时通过尝试任何内联格式的标签组合。

在你尝试定义一个跨越数百行的巨大配置对象之前,在一个块中定义 typedef 是可以的。必须跳转到文件顶部才能找到该键的属性描述非常麻烦。

标签: javascriptnode.jsjsdoc

解决方案


推荐阅读