在VS Code中为通过Object.assign隐式赋值属性的构造函数配置JSDoc类型提示

嘿，我之前也碰到过一模一样的问题——用Object.assign给构造函数实例隐式赋值属性后，VS Code完全识别不到这些属性的类型提示，写代码全靠记忆太难受了！结合你不想重复定义属性、避免冗余代码的需求，给你分享两个实用的解决方案：

方案一：用@typedef统一管理属性结构 + @this关联实例类型 #

这个方案只需要一次性定义所有属性的类型结构，然后关联到构造函数的this上，完全不用重复写属性列表，完美匹配你的要求：

/**
 * 先统一定义书籍实例的所有属性类型（只写这一次就够了！）
 * @typedef {Object} BookProps
 * @property {string} title - 书籍标题
 * @property {string} description - 书籍描述
 * @property {number} year - 出版年份
 * @property {string} author - 书籍作者
 */

/**
 * 书籍构造函数
 * @constructor
 * @this {BookProps} // 告诉IDE：这个构造函数的实例就是BookProps类型
 * @param {BookProps['title']} title - 书籍标题（直接复用typedef的类型，避免重复写string）
 * @param {BookProps['description']} description - 书籍描述
 * @param {BookProps['year']} year - 出版年份
 * @param {BookProps['author']} author - 书籍作者
 */
function BookFn(title, description, year, author) {
  // 原逻辑完全不变，继续用Object.assign隐式赋值
  Object.assign(this, {title, description, year, author});
}

BookFn.prototype = {
  titleAuthor() { 
    // 现在VS Code能自动识别this.title和this.author的类型啦！
    return this.title + ' by ' + this.author
  },
};

let book1 = new BookFn('book1', 'description1', 2020, 'author1');
let t = book1.title; // 这里IDE会自动提示title属性，类型是string！

这个方案的核心是用@typedef把所有属性的类型集中管理，然后通过@this {BookProps}明确告诉VS Code：这个构造函数生成的实例，拥有BookProps里定义的所有属性。参数类型也直接复用BookProps的属性类型，彻底杜绝冗余代码。

方案二：调整参数结构，用解构参数+JSDoc直接推断类型 #

如果你能接受把构造函数的多个独立参数改成一个对象参数，那可以不用写typedef，直接通过JSDoc的解构注释让IDE自动推断类型，更简洁：

/**
 * 书籍构造函数（参数改为对象结构）
 * @constructor
 * @param {Object} props - 书籍属性集合
 * @param {string} props.title - 书籍标题
 * @param {string} props.description - 书籍描述
 * @param {number} props.year - 出版年份
 * @param {string} props.author - 书籍作者
 */
function BookFn({title, description, year, author}) {
  Object.assign(this, {title, description, year, author});
  // 甚至可以简化成 Object.assign(this, props);
}

// 调用时传对象参数
let book1 = new BookFn({
  title: 'book1',
  description: 'description1',
  year: 2020,
  author: 'author1'
});

这种方式下，VS Code会直接根据@param的解构注释，自动推断出实例的所有属性类型，连@this都不用写，非常清爽。

为什么你之前用@property/@typedef没效果？ #

你之前尝试的@property没生效，是因为单独在@constructor的JSDoc里写@property，VS Code的JSDoc解析器不会自动把这些属性关联到构造函数的this上——必须通过@this明确指定实例的类型（比如方案一里的@this {BookProps}），才能让IDE正确识别实例的属性。

备注：内容来源于stack exchange，提问作者S.Serpooshan