如何用JSDoc实现VSCode中扩展类方法的IntelliSense

问题根源 #

当前代码中context的@typedef定义在基类之后，JSDoc按顺序解析类型时，基类方法注释里的context类型未被识别，导致子类重写时无法继承类型提示。

解决方案1：调整typedef位置到基类之前 #

将类型定义移到基类代码上方，确保基类方法的参数类型能被正确解析，子类重写时自动继承类型提示：

/**
 * @typedef {Object} Context
 * @prop {string} contextString
 * @prop {number} someNumber
 */

class BaseClass {
    /**
     * @param {Context} context
     */
    myMethod(context) {
        console.warn('myMethod should be overwritten')
    }
}

class UsersClass extends BaseClass {
    myMethod(context) {
        // 此时输入context.可触发IntelliSense，显示contextString、someNumber等属性提示
        console.log(context.contextString);
    }
}

解决方案2：子类重写时显式标注类型 #

若无法调整typedef位置，可在子类的重写方法中通过JSDoc显式标注参数类型，结合@override增强类型关联：

class BaseClass {
    /**
     * @param {Context} context
     */
    myMethod(context) {
        console.warn('myMethod should be overwritten')
    }
}

class UsersClass extends BaseClass {
    /**
     * @override
     * @param {Context} context
     */
    myMethod(context) {
        // 此处context参数可获得完整的IntelliSense提示
    }
}

/**
 * @typedef {Object} Context
 * @prop {string} contextString
 * @prop {number} someNumber
 */

额外注意 #

类型名建议首字母大写（如Context），避免与变量名冲突，同时符合JSDoc的命名规范。

内容的提问来源于stack exchange，提问作者MilesZew