javascript - 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 是可以的。必须跳转到文件顶部才能找到该键的属性描述非常麻烦。
解决方案
推荐阅读
- discord - Discord 交互,将消息从短暂变为公开
- java - 冲刺重试:org.hibernate.exception.JDBCConnectionException
- powershell - 使用 PowerShell 获取超过 5 天的卷影副本
- node.js - TypeORM“不能在模块外使用导入语句”在非常新的项目上
- unity3d - 如何在 Unity 中添加控制器?
- c++ - 包含彼此的标题会产生一些奇怪的错误
- node.js - nodejs在前端使用rest api
- python - 如何防止 Google Cloud Storage 两次执行请求?
- google-sheets - 计算谷歌工作表中重复出现的次数
- react-native - expo-av 音频 unloadAsync removeSubscription 问题