2015-05-03 14 views
13

Sto utilizzando JSDoc per la documentazione dei parametri.Come documentare una funzione restituita da una funzione utilizzando JSDoc

È chiaro come documentare i tipi di parametri per many_prompts, ma qual è il modo corretto per documentare la funzione restituita?

/** 
* @param {Number} - number of times to prompt 
* @return {Function(prompt{Number})} - the returned function 
*/ 
function many_prompts(count) { 
    return function(prompt) { 
    for(var i=0; i < count; i++) alert(prompt); 
    } 
} 


//Example of use: 
var y =many_prompts(3); 
y('Hello World'); 

risposta

7

È possibile documentare la funzione interna e quindi fare riferimento in questa maniera

/** 
* @param {Number} - number of times to prompt 
* @return {many_prompts~inner} - the returned function 
*/ 
function many_prompts(count){ 
    /** 
    * My inner function 
    * 
    * @param {object} prompt Some parameter 
    */ 
    var inner = function(prompt){ 
    for(var i=0;i<count;i++) alert(prompt} 
    }; 
    return inner; 
} 
+3

C'è un modo per fare questo per le funzioni interne anonime? –

+0

Per JSDoc avresti bisogno di qualche forma di riferimento, suppongo che dipenda da come viene utilizzata la funzione anonima. Hai un esempio? – SGD

+1

Questo documento è documentato ovunque ufficialmente? Non riesco a trovarlo –

Problemi correlati