You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在VS Code中通过JSDoc将typedef从一个文件导入到另一个文件?

带JSDoc类型标注的导出对象示例

下面是整理好的File1.js代码,完整保留了所有类型定义和注释:

/**
 * 每个对象的类型定义。
 * @typedef {Object} MyObject1
 * @property {String} username 你的用户名
 * @property {String} realname 你的真实姓名
 * @property {boolean} isUnique 你是否是独一无二的个体?
 */
module.exports = {
  /**
   * 第一个人!
   * @type {MyObject1}
   */
  myperson: {
    username: 'TheDragonSlayer',
    realname: 'George',
    isUnique: true
  },
  /**
   * 第二个人...的内容
   */
  // 你可以在这里补充符合MyObject1类型的对象内容,比如:
  // secondPerson: {
  //   username: 'CodeWizard',
  //   realname: 'Alice',
  //   isUnique: true
  // }
}

这段代码用JSDoc的@typedef定义了清晰的对象类型规范,每个属性的类型和用途都标注得明明白白,导出的myperson对象也通过@type绑定了类型,不管是自己后续维护还是给团队成员参考,可读性都拉满~

内容的提问来源于stack exchange,提问作者FireController1847

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.05.25 03:50:43