Wie dokumentiere ich ein Wörterbuch in JSDoc?

Mit dem nächsten Beispiel:

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

Und wenn ich weiß, dass die Eigenschaft locale ein Wörterbuchobjekt enthält, das aus der Datenbank stammt, wie kann ich seine inneren Eigenschaften mit JSDoc dokumentieren?

Derzeit denke ich daran, typedef für meine Gebietsschemaobjekte zu tippen. Kann ich die localeEigenschaft dann möglicherweise einfach auf ein Array meines definierten Typs festlegen ? Ist das der richtige Weg?

Laut den JSDoc 3-Dokumenten :

Arrays und Objekte (Typanwendungen und Datensatztypen)

Ein Objekt mit Zeichenfolgenschlüsseln und Zahlenwerten:

{Object.<string, number>}

So wäre es:

/** @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:

Die Verwendung @typedefund @propertyDefinition eines benutzerdefinierten Typs ist in JSDoc die "richtige" Methode. Aber es ist umständlich zu schreiben und hässlich zu lesen (eine Hauptsünde in der Dokumentation).

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

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