Wie beschreibt man "Object"-Argumente in jsdoc?

Question

// Meine Funktion macht X und Y.
// @params {object} parameters Ein Objekt, das die Parameter enthält
// @params {function} callback Die Rückruffunktion
function(parameters, callback) {
}

Aber wie beschreibe ich, wie das Parameterobjekt strukturiert sein sollte? Zum Beispiel sollte es so aussehen:

{
  setting1 : 123, // (erforderlich, Ganzzahl)
  setting2 : 'asdf' // (optional, Zeichenkette)
}

Answer 1

Es gibt ein neues @config-Tag für diese Fälle. Sie verlinken auf das vorherige @param.

/** Meine Funktion macht X und Y.
    @params {object} parameters Ein Objekt mit den Parametern
    @config {integer} setting1 Eine erforderliche Einstellung.
    @config {string} [setting2] Eine optionale Einstellung.
    @params {MyClass~FuncCallback} callback Die Rückruffunktion
*/
function(parameters, callback) {
    // ...
};

/**
 * Dieser Rückruf wird als Teil der MyClass-Klasse angezeigt.
 * @callback MyClass~FuncCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */