如何在JSDoc中记录词典？

Question

有下一个例子：

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

知道locale属性包含的是来自数据库的dictionary对象，我如何用JSDoc记录其内部属性？

目前，我正在考虑为我的区域设置对象键入typedef，那么我可以将locale属性设置为我定义的类型的数组吗？这样做对吗？

Answer 1

据我所知：

在JSDoc中，使用类型定义和属性定义自定义类型是“正确的”。但它写起来很麻烦，读起来很难看（文档中的一大罪过）。

记录类型要整洁得多（注意双精度）：

   /** {{
         name:string, 
         lang:string
   }} */

Answer 2

根据JSDoc 3文件：

数组和对象（类型应用程序和记录类型）

具有字符串键和数字值的对象：

<代码>{对象。

所以它将是：

/** @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"
        }
    }
};