javascript - 如何在 JSDoc 中记录字典？

Question

有下一个例子:

var CONF = {
    locale: {
        "en": {
            name: "English",
            lang: "en-US"
        },
        "es": {
            name: "Spanish",
            lang: "es-ES"
        }
    }
};

知道 locale 属性包含的是一个字典对象，它来自数据库，我如何用 JSDoc 记录它的内部属性？

目前我正在考虑为我的语言环境对象输入 typedef 类型，那么我是否可以将 locale 属性设置为我定义类型的简单数组？这是正确的做法吗？

Answer 1

根据JSDoc 3 docs :

Arrays and objects (type applications and record types)

An object with string keys and number values:

{Object.<string, number>}

那就是:

/** @type {{locales: Object.<string, {name: string, lang: string}>}} */
var CONF = {
    locales: {
        en: {
            name: "English",
            lang: "en-US"
        },
        es: {
            name: "Spanish",
            lang: "es-ES"
        }
    }
};

清洁器，使用 @typedef

/**
 * @typedef {{name: string, lang: string}} locale
 */
/**
 * @type {{locales: Object.<string, locale>}}
 */
var CONF = {
    locales: {
        en: {
            name: "English",
            lang: "en-US"
        },
        es: {
            name: "Spanish",
            lang: "es-ES"
        }
    }
};