使用变量定义 JSDoc 类型 [WebStorm 友好]

Question

在下面的代码中，我想使用testSettings 变量定义ApplicationSettings 类型的形状，以便在useSettings 函数IDE 中知道settings 对象上可以访问哪些属性：

/** @typedef ApplicationSettings */
var testSettings = {
    apiService: {},
    configuration: {}
};

/**
 * @param {ApplicationSettings} settings
 */
function useSettings(settings) {
    console.log(settings.apiService); // apiService is not recognized here
    console.log(settings.configuration); // same for configuration
}

不幸的是，@typedef 在这种情况下似乎不是一个有效的注释。是否可以告诉 WebStorm ApplicationSettings 类型应该是什么样子，而无需在 JSDoc 中明确指定其所有属性？

Answer 1

这里为什么需要@typedef？以下语法有效：

var testSettings = {
    apiService: {},
    configuration: {}
};

/**
 * @param {testSettings} settings
 */
function useSettings(settings) {
    console.log(settings.apiService); 
    console.log(settings.configuration);