Wie dokumentiert man ein Wörterbuch in JSDoc?

Nächstes Beispiel haben:

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

Und da ich weiß, dass die Locale-Eigenschaft ein Dictionary-Objekt enthält, das aus der Datenbank stammt, wie kann ich seine inneren Eigenschaften mit JSDoc dokumentieren?

Momentan denke ich darüber nach typedef Typ für meine Gebietsschema-Objekte, dann kann ich das einstellen locale Eigenschaft einfach ein Array meines definierten Typs? Ist dies der richtige Weg?

Laut dem JSDoc 3-Dokumente:

Arrays und Objekte (Typanwendungen und Datensatztypen)

Ein Objekt mit Zeichenfolgenschlüsseln und Zahlenwerten:

{Object.<string, number>}

Es wäre also:

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

Reiniger, mit @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"
        }
    }
};

Soweit ich sagen kann:

Verwenden @typedef und @property Einen benutzerdefinierten Typ zu definieren, ist der “richtige” Weg in JSDoc. Aber es ist umständlich zu schreiben und hässlich zu lesen (eine Todsünde in der Dokumentation).

Der Datensatztyp ist viel übersichtlicher (beachten Sie die doppelte {{s):

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