JSDoc: Come documentare il valore letterale dell'oggetto "options" per una "classe" genitore?

Question

Sto usando la "classe" di jQuery $.widget() che fornisce un metodo option(). Poiché il metodo non è nel mio codice, non ho un posto dove documentare l'argomento.

Ho provato a inserire jsDoc sui campi nelle opzioni predefinite letterali, ma semplicemente non vengono prelevati. Poi ho provato a usare i tag @class e @lends sullo stesso oggetto letterale, ma questo potrebbe essere abbastanza confuso in quanto l'oggetto letterale non è realmente una classe.

Un'altra alternativa che ho sperimentato è di inserire qualcosa come @param options.field description nel jsDoc del costruttore. Tuttavia, questo ha lo svantaggio di separare la documentazione dal codice. Inoltre, il costruttore non ha in realtà un argomento chiamato options poiché è gestito da jQuery.

Come gestiscono i guru Javascript? Dovrebbe essere proposto un nuovo tag?

Answer 1

Se ho compreso correttamente la tua domanda, hai una funzione che accetta un oggetto opzioni e vuoi documentare tutti i suoi membri?

Un esempio di massima di come farlo in JSDoc è come qui sotto:

/** 
* @description 
* Compliment someone on their something. 
* 
* @param {Object} options 
* @param {String} options.name A person's name 
* @param {String} options.feature A person's property 
*/ 
function flatter (options) { 
    options = options || {}; 
    console.log('%s, loving your %s!', options.name, options.feature); 
}